diff --git a/src/_data/whats-new.yml b/src/_data/whats-new.yml index b2e8a5cfe8e..647ee4d1398 100644 --- a/src/_data/whats-new.yml +++ b/src/_data/whats-new.yml @@ -2450,7 +2450,7 @@ entries: date: October 8, 2019 link: https://github.com/magento/devdocs/pull/5586 - description: Updated the REST schema for [2.3.3](https://devdocs.magento.com/redoc/2.3/) - and [2.2.10](https://devdocs.magento.com/swagger/index_22.html). + and [2.2.10](https://devdocs.magento.com/swagger/index.html). versions: 2.2.10, 2.3.3 type: Major update date: October 8, 2019 @@ -3170,7 +3170,7 @@ entries: date: June 22, 2019 link: https://github.com/magento/devdocs/pull/4824 - description: Updated the REST schema for [2.3.2](https://devdocs.magento.com/redoc/2.3/) - and [2.2.9](https://devdocs.magento.com/swagger/index_22.html). + and [2.2.9](https://devdocs.magento.com/swagger/index.html). versions: 2.2.9, 2.3.2 type: Major update date: June 22, 2019 diff --git a/src/_includes/install/sampledata/sample-data-rc1-cli-24.md b/src/_includes/install/sampledata/sample-data-rc1-cli-24.md new file mode 100644 index 00000000000..084969cf6d7 --- /dev/null +++ b/src/_includes/install/sampledata/sample-data-rc1-cli-24.md @@ -0,0 +1,86 @@ +## Command-line upgrade to Magento {{ page.guide_version }} with sample data + +These instructions apply to {{site.data.var.ce}} and {{site.data.var.ee}} users *only* if all of the following are true: + +* You have installed optional sample data +* You are upgrading to Magento {{ page.guide_version }} (including a Release Candidate) from any earlier version using the command line + +To upgrade to Magento {{ page.guide_version }} sample data using the command line: + +1. Log in to your Magento server as, or switch to, the [Magento file system owner]. +1. Change to the Magento installation directory. +1. Back up your current `composer.json` file: + + ```bash + cp composer.json composer.json.bak + ``` + +1. Upgrade the Magento software version using commands of the following format: + + ```bash + composer require --no-update + ``` + + ```bash + composer require : ... : --no-update + ``` + + * Example for {{site.data.var.ce}}: + + ```bash + composer require magento/product-community-edition {{ page.guide_version }}.0 --no-update + ``` + + ```bash + composer require magento/module-bundle-sample-data:100.4.* magento/module-widget-sample-data:100.4.* magento/module-theme-sample-data:100.4.* magento/module-catalog-sample-data:100.4.* magento/module-customer-sample-data:100.4.* magento/module-cms-sample-data:100.4.* magento/module-catalog-rule-sample-data:100.4.* magento/module-sales-rule-sample-data:100.4.* magento/module-review-sample-data:100.4.* magento/module-tax-sample-data:100.4.* magento/module-sales-sample-data:100.4.* magento/module-grouped-product-sample-data:100.4.* magento/module-downloadable-sample-data:100.4.* magento/module-msrp-sample-data:100.4.* magento/module-configurable-sample-data:100.4.* magento/module-product-links-sample-data:100.4.* magento/module-wishlist-sample-data:100.4.* magento/module-swatches-sample-data:100.4.* magento/sample-data-media:100.4.* magento/module-offline-shipping-sample-data:100.4.* --no-update + ``` + + * Example for {{site.data.var.ee}}: + + ```bash + composer require magento/product-enterprise-edition {{ page.guide_version }}.0 --no-update + ``` + + ```bash + composer require magento/module-bundle-sample-data:100.4.* magento/module-widget-sample-data:100.4.* magento/module-theme-sample-data:100.4.* magento/module-catalog-sample-data:100.4.* magento/module-customer-sample-data:100.4.* magento/module-cms-sample-data:100.4.* magento/module-catalog-rule-sample-data:100.4.* magento/module-sales-rule-sample-data:100.4.* magento/module-review-sample-data:100.4.* magento/module-tax-sample-data:100.4.* magento/module-sales-sample-data:100.4.* magento/module-grouped-product-sample-data:100.4.* magento/module-downloadable-sample-data:100.4.* magento/module-msrp-sample-data:100.4.* magento/module-configurable-sample-data:100.4.* magento/module-product-links-sample-data:100.4.* magento/module-wishlist-sample-data:100.4.* magento/module-swatches-sample-data:100.4.* magento/sample-data-media:100.4.* magento/module-offline-shipping-sample-data:100.4.* magento/module-gift-card-sample-data:100.4.* magento/module-customer-balance-sample-data:100.4.* magento/module-target-rule-sample-data:100.4.* magento/module-gift-registry-sample-data:100.4.* magento/module-multiple-wishlist-sample-data:100.4.* --no-update + ``` + + {% include note.html + type="info" + content="To upgrade to a Release Candidate, append `-rc` to the version of each module. For example, `-rc3`." + %} + +1. Update dependencies: + + ```bash + composer update + ``` + +1. If prompted, enter your [authentication keys]. +1. Wait for dependencies to update. + +### Finish your upgrade + +After you have reset file system permissions: + +1. If you have not done so already, log in to your Magento server as, or switch to, the Magento file system owner. +1. Change to your Magento installation directory. +1. Manually clear the `var/cache`, `var/page_cache`, and `var/generation` directories. + + A sample command follows: + + ```bash + rm -rf var/cache/* var/page_cache/* var/generation/* + ``` + +1. Upgrade Magento: + + ```bash + bin/magento setup:upgrade + ``` + +{% include install/sampledata/file-sys-perms-digest.md %} + + +[Magento file system owner]: {{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html +[authentication keys]: {{ page.baseurl }}/install-gde/prereq/connect-auth.html diff --git a/src/cloud/reference/discover-deploy.md b/src/cloud/reference/discover-deploy.md index b9614025f40..e76ce6b1efc 100644 --- a/src/cloud/reference/discover-deploy.md +++ b/src/cloud/reference/discover-deploy.md @@ -31,10 +31,10 @@ A set of YAML configuration files located in the project root directory define y For all Starter environments and Pro Integration environments, pushing your Git branch updates all settings and configurations dependent on these files. -- [`.magento.app.yaml`]({{ site.baseurl }}/cloud/project/magento-app.html)—defines how to build and deploy Magento, including services, hooks, cron jobs, and more. +- [`.magento.app.yaml`]({{ site.baseurl }}/cloud/project/magento-app.html)—defines how to build and deploy Magento, including user access, service mapping (relationships), hooks, cron jobs, and more. - [`.magento.env.yaml`]({{ site.baseurl }}/cloud/project/magento-env-yaml.html)—centralizes the management of build and deploy actions across all of your environments, including Pro Staging and Production, using environment variables. - [`.magento/routes.yaml`]({{ site.baseurl }}/cloud/project/routes.html)—defines how Magento processes an incoming URL. -- [`.magento/services.yaml`]({{ site.baseurl }}/cloud/project/services.html)—defines the services Magento uses by name and version. For example, this file may include versions of MySQL, PHP extensions, and Elasticsearch. These are referred to as *services*. +- [`.magento/services.yaml`]({{ site.baseurl }}/cloud/project/services.html)—defines the services Magento uses by name and version. For example, this file can include versions of MySQL, PHP extensions, and Elasticsearch. These are referred to as *services*. - [`app/etc/config.php`]({{ site.baseurl }}/cloud/live/sens-data-over.html)—defines the [system-specific settings]({{ site.baseurl }}/cloud/live/sens-data-over.html#configuration-data) Magento uses to configure your store. Magento generates this file if it does not detect it during the build phase. See [Configuration Management]({{ site.baseurl }}/cloud/live/sens-data-over.html) for information on how to use this file to manage and synchronize the Magento application configuration across your Cloud environments. ## Required files for your Git branch {#requiredfiles} diff --git a/src/guides/v2.3/extension-dev-guide/extension_attributes/adding-attributes.md b/src/guides/v2.3/extension-dev-guide/extension_attributes/adding-attributes.md index e5ae4462eaa..2f5ca63ffd7 100644 --- a/src/guides/v2.3/extension-dev-guide/extension_attributes/adding-attributes.md +++ b/src/guides/v2.3/extension-dev-guide/extension_attributes/adding-attributes.md @@ -181,7 +181,9 @@ Now we need to bind our plugin to `ProductInterface`: ## Extension Attributes Configuration: -For scalar attributes we can use next configuration: +The file that holds these extension attributes must reside under the `/etc` folder of your module. + +For scalar attributes, we can use the following configuration: ```xml @@ -192,6 +194,8 @@ For scalar attributes we can use next configuration: ``` +Here, the scalar attributes indicate the simple form of attribute representation, such as an integer or a string. Specify the class or interface of the extension attributes inside the "for" attribute of the `` tag. In this case, it is the ProductInterface. The attribute is specified with a unique code and its type. + For non-scalar attributes: ```xml @@ -202,6 +206,8 @@ For non-scalar attributes: ``` +Here, the non-scalar attributes indicate data objects such as the instance of a class. In the above example, the CustomDataInterface object is added as an extension attribute. + For array extension attributes: ```xml @@ -212,6 +218,8 @@ For array extension attributes: ``` +The array extension attributes are just an extension of the scalar attributes where a range of values can be represented as an attribute. The `[]` symbol indicates the attribute type is an array. + The array indicator `[]` can also be appended to non-scalar types. In first - scalar - case we will get the next result: diff --git a/src/guides/v2.3/extension-dev-guide/indexing.md b/src/guides/v2.3/extension-dev-guide/indexing.md index 876feb65465..d67491229b5 100644 --- a/src/guides/v2.3/extension-dev-guide/indexing.md +++ b/src/guides/v2.3/extension-dev-guide/indexing.md @@ -99,6 +99,10 @@ The Magento indexing mechanism uses the status value in reindex triggering proce Reindexing can be performed in two modes: * Update on Save - index tables are updated immediately after the dictionary data is changed. + +{:.bs-callout-info} +**Update on Save** indexers must use custom code (plugins, events or any other working approach) in order to trigger reindexing when entities are saved/deleted etc. + * Update by Schedule - index tables are updated by cron job according to the configured schedule. {:.bs-callout-info} diff --git a/src/guides/v2.3/extension-dev-guide/searching-with-repositories.md b/src/guides/v2.3/extension-dev-guide/searching-with-repositories.md index db426063654..c23b3608c72 100644 --- a/src/guides/v2.3/extension-dev-guide/searching-with-repositories.md +++ b/src/guides/v2.3/extension-dev-guide/searching-with-repositories.md @@ -507,3 +507,6 @@ The `di.xml` configuration file excerpt below shows how you can create a virtual ``` + +{:.bs-callout-info} +When building an EAV Model that needs to implement the `Repository::getList` method, use the EAV Filter Processor; otherwise the custom filters will not be added to the collection. diff --git a/src/guides/v2.3/frontend-dev-guide/css-guide/css_quick_guide_approach.md b/src/guides/v2.3/frontend-dev-guide/css-guide/css_quick_guide_approach.md index 1fe41aef258..29383b1d5f9 100644 --- a/src/guides/v2.3/frontend-dev-guide/css-guide/css_quick_guide_approach.md +++ b/src/guides/v2.3/frontend-dev-guide/css-guide/css_quick_guide_approach.md @@ -26,6 +26,31 @@ To extend the parent theme's styles in your theme: 1. Add your Less code in this file. +However, the above only works if the theme's parent is a Blank. Consider a Theme A which is the child of Blank. Theme A has two children, B and C. A global style rule is added to the `_extend.less` file of theme A. This extends its parent Blank. Theme B and C also have their own `_extend.less` files. Theme B and C will override the parent (Theme A), rather than extending it further. Theme B & Theme C are extending their grandparent (Blank) and overriding their parent (Theme A) in this setup. + +In case of subsequent descendants of the child theme, you can avoid this behavior by following these steps: + +1. Create a `_extend-child.less` in both your parent and child themes. +1. Keep `_extend-child.less` empty in your parent theme and add it too your parent theme's `_extend.less` file. +1. Add a `@import '_extend-child.less'` rule to the end of your parent's theme's `_extend.less` file. +1. In your child theme, add `@import` or style rules in `_extend-child.less` to extend parent theme's CSS. + + ```tree + app/design/frontend/Vendor/ + ├── parent + │ └── web + │ └── css + │ └── source + │ ├── _extend-child.less (keep this file empty) + │ └── _extend.less + └── child + └── web + └── css + └── source + └── _extend-child.less + ... + ``` + Extending a theme using `_extend.less` is the simplest option when you are happy with everything the parent theme has, but want to add more styles. {:.bs-callout-info} diff --git a/src/guides/v2.3/frontend-dev-guide/css-topics/using-fonts.md b/src/guides/v2.3/frontend-dev-guide/css-topics/using-fonts.md index 61f11c7df69..9d86ab92f98 100644 --- a/src/guides/v2.3/frontend-dev-guide/css-topics/using-fonts.md +++ b/src/guides/v2.3/frontend-dev-guide/css-topics/using-fonts.md @@ -64,7 +64,7 @@ To ensure the stability of your customizations and prevent upgrades from overwri Fallback web fonts that are used by default in Magento are located in `lib/web/css/source/lib/variables/_typography.less`. - For more information about font-face, refer to this article [Font-face][https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face]{:target="_blank"}. + For more information about font-face, refer to this article [Font-face](https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face){:target="_blank"}. ## `` head type diff --git a/src/guides/v2.3/graphql/index.md b/src/guides/v2.3/graphql/index.md index 8a8ab7c5318..b4ef57acdbc 100755 --- a/src/guides/v2.3/graphql/index.md +++ b/src/guides/v2.3/graphql/index.md @@ -10,9 +10,9 @@ landing-page: GraphQL Developer's Guide As of Magento 2.3.4, GraphQL provides the following features: -* Support for all product types, payment methods, and shipping methods -* Achieved <.5 sec average response times with 500 concurrent requests -* Redesigned a feature rich layered navigation +- Support for all product types, payment methods, and shipping methods +- Achieved <.5 sec average response times with 500 concurrent requests +- Redesigned a feature rich layered navigation ## Where we're going @@ -20,12 +20,12 @@ The `graphql-ce` Community Engineering repository has been archived. Development For the 2.4.0 and 2.4.1 releases, Magento teams are working toward completing GraphQL coverage for Business to Consumer (B2C) uses cases, with emphasis on the following: -* Reorders -* Inventory Management store pickups -* Order history for logged in customers -* Replace product-specific mutations that add products to a cart with a single mutation that can handle all product types -* Gift wrapping and messages -* Saved payment methods +- Reorders +- Inventory Management store pickups +- Order history for logged in customers +- Replace product-specific mutations that add products to a cart with a single mutation that can handle all product types +- Gift wrapping and messages +- Saved payment methods We also expect to begin adding coverage for B2B scenarios. diff --git a/src/guides/v2.3/graphql/queries/cms-page.md b/src/guides/v2.3/graphql/queries/cms-page.md index 04119897ed9..0ea2b6b5283 100644 --- a/src/guides/v2.3/graphql/queries/cms-page.md +++ b/src/guides/v2.3/graphql/queries/cms-page.md @@ -15,13 +15,14 @@ Return the contents of a CMS page: ## Example usage -The following query returns information about the "404 Not Found" CMS page: +You must include the CMS page identifier value to retrieve the content of a specific CMS page. The following query returns information about the "404 Not Found" CMS page: **Request:** ```graphql { cmsPage(identifier: "no-route") { + identifier url_key title content @@ -40,6 +41,7 @@ The following query returns information about the "404 Not Found" CMS page: { "data": { "cmsPage": { + "identifier": "no-route" "url_key": "no-route", "title": "404 Not Found", "content": "
\r\n
The page you requested was not found, and we have a fine guess why.
\r\n
\r\n
    \r\n
  • If you typed the URL directly, please make sure the spelling is correct.
  • \r\n
  • If you clicked on a link to get here, the link is outdated.
  • \r\n
\r\n
\r\n
\r\n
What can you do?
\r\n
Have no fear, help is near! There are many ways you can get back on track with Magento Store.
\r\n
\r\n
    \r\n
  • Go back to the previous page.
  • \r\n
  • Use the search bar at the top of the page to search for your products.
  • \r\n
  • Follow these links to get you back on track!
    Store Home | My Account
\r\n", diff --git a/src/guides/v2.3/graphql/tutorials/checkout/checkout-add-product-to-cart.md b/src/guides/v2.3/graphql/tutorials/checkout/checkout-add-product-to-cart.md index 93197ba1b0a..3c1214e90e7 100644 --- a/src/guides/v2.3/graphql/tutorials/checkout/checkout-add-product-to-cart.md +++ b/src/guides/v2.3/graphql/tutorials/checkout/checkout-add-product-to-cart.md @@ -31,9 +31,11 @@ If you add a product to the shopping cart as a registered customer, be sure to s ## Add a simple product into the shopping cart -`{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). +The following mutation adds a simple product into the shopping cart. -The following mutation adds a **simple product** into shopping cart. +Replace `{ CART_ID }` with the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). + +In this example, we will add the Aim Analog Watch (SKU 24-MG04) from the default Luma catalog to the cart. The SKU identifies the product to be added. **Request:** @@ -46,7 +48,7 @@ mutation { { data: { quantity: 1 - sku: "simple-product" + sku: "24-MG04" } } ] @@ -75,9 +77,9 @@ mutation { "cart": { "items": [ { - "id": "508", + "id": "5", "product": { - "sku": "simple-product", + "sku": "24-MG04", "stock_status": "IN_STOCK" }, "quantity": 1 @@ -91,7 +93,8 @@ mutation { ## Add a virtual product into the shopping cart -The following mutation adds a **virtual product** into shopping cart. +The following mutation adds a virtual product into the shopping cart. +In this example, we add the Beginner's Yoga video downloadable product (SKU 240-LV04). **Request:** @@ -104,7 +107,7 @@ mutation { { data: { quantity: 1 - sku: "virtual-product" + sku: "240-LV04" } } ] @@ -133,9 +136,17 @@ mutation { "cart": { "items": [ { - "id": "509", + "id": "5", "product": { - "sku": "virtual-product", + "sku": "24-MG04", + "stock_status": "IN_STOCK" + }, + "quantity": 1 + }, + { + "id": "6", + "product": { + "sku": "240-LV04", "stock_status": "IN_STOCK" }, "quantity": 1 @@ -147,6 +158,8 @@ mutation { } ``` +The response lists all items currently in the cart, including the just-added video download. + ## Verify this step {#verify-step} 1. Sign in as a customer to the website using the email `john.doe@example.com` and password `b1b2b3l@w+`. diff --git a/src/guides/v2.3/graphql/tutorials/checkout/checkout-billing-address.md b/src/guides/v2.3/graphql/tutorials/checkout/checkout-billing-address.md index 4012e0326ab..57dbc8e4746 100644 --- a/src/guides/v2.3/graphql/tutorials/checkout/checkout-billing-address.md +++ b/src/guides/v2.3/graphql/tutorials/checkout/checkout-billing-address.md @@ -17,21 +17,16 @@ contributor_link: https://www.atwix.com/ {:.bs-callout-tip} You must always set the billing address to place an order. -Use the [setBillingAddressOnCart]({{ page.baseurl }}/graphql/mutations/set-billing-address.html) mutation to set a billing address. You can set the billing address in the following ways: +Use the [setBillingAddressOnCart]({{ page.baseurl }}/graphql/mutations/set-billing-address.html) mutation to set a billing address. -* Add a new billing address -* Add a new billing address and set it as the shipping addresses -* Use an address from the logged-in customer's address book +## Add a billing address to the cart -## Add a new billing address +Similar to the shipping address, add a billing address to the cart. `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). The street address is also different, so we can see that different addresses are being created. -The following mutation adds a new billing address. `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). +Send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. **Request:** -{:.bs-callout .bs-callout-info} -For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. - ```graphql mutation { setBillingAddressOnCart( @@ -42,236 +37,15 @@ mutation { firstname: "John" lastname: "Doe" company: "Company Name" - street: ["320 N Crescent Dr", "Beverly Hills"] + street: ["64 Strawberry Dr", "Beverly Hills"] city: "Los Angeles" region: "CA" + region_id: 12 postcode: "90210" country_code: "US" telephone: "123-456-0000" - save_in_address_book: false - } - } - } - ) { - cart { - billing_address { - firstname - lastname - company - street - city - region{ - code - label - } - postcode - telephone - country { - code - label - } - } - } - } -} -``` - -**Response:** - -```json -{ - "data": { - "setBillingAddressOnCart": { - "cart": { - "billing_address": { - "firstname": "John", - "lastname": "Doe", - "company": "Company Name", - "street": [ - "320 N Crescent Dr", - "Beverly Hills" - ], - "city": "Los Angeles", - "region": { - "code": "CA", - "label": "California" - }, - "postcode": "90210", - "telephone": "123-456-0000", - "country": { - "code": "US", - "label": "US" - } - } - } - } - } -} -``` - -## Add a new address for billing and shipping - -The following mutation includes the `same_as_shipping` attribute, which allows the same address to be used for billing and shipping. - -**Request:** - -```text -mutation { - setBillingAddressOnCart( - input: { - cart_id: "{ CART_ID }" - billing_address: { - address: { - firstname: "John" - lastname: "Doe" - company: "Company Name" - street: ["320 N Crescent Dr", "Beverly Hills"] - city: "Los Angeles" - region: "CA" - postcode: "90210" - country_code: "US" - telephone: "123-456-0000" - save_in_address_book: false - } - same_as_shipping: true - } - } - ) { - cart { - billing_address { - firstname - lastname - company - street - city - region{ - code - label - } - postcode - telephone - country { - code - label - } - } - shipping_addresses { - firstname - lastname - company - street - city - postcode - telephone - country { - code - label - } - } - } - } -} -``` - -**Response:** - -```json -{ - "data": { - "setBillingAddressOnCart": { - "cart": { - "billing_address": { - "firstname": "John", - "lastname": "Doe", - "company": "Company Name", - "street": [ - "320 N Crescent Dr", - "Beverly Hills" - ], - "city": "Los Angeles", - "region": { - "code": "CA", - "label": "California" - }, - "postcode": "90210", - "telephone": "123-456-0000", - "country": { - "code": "US", - "label": "US" - } - }, - "shipping_addresses": [ - { - "firstname": "John", - "lastname": "Doe", - "company": "Company Name", - "street": [ - "320 N Crescent Dr", - "Beverly Hills" - ], - "city": "Los Angeles", - "postcode": "90210", - "telephone": "123-456-0000", - "country": { - "code": "US", - "label": "US" - } - } - ] - } - } - } -} -``` - -## Use an existing customer address - -First, query the customer to return the list of address IDs. - -**Request:** - -```text -query { - customer { - addresses { - id - default_billing - default_shipping - } - } -} -``` - -**Response:** - -```text - "data": { - "customer": { - "addresses": [ - { - "id": 2, - "default_billing": true, - "default_shipping": true + save_in_address_book: true } - ] - } - } -} -``` - -Set `{ CUSTOMER_ADDRESS_ID }` to an `id` returned in the query. - -`{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). - -**Request:** - -```text -mutation { - setBillingAddressOnCart( - input: { - cart_id: "{ CART_ID }" - billing_address: { - customer_address_id: { CUSTOMER_ADDRESS_ID } } } ) { @@ -310,7 +84,7 @@ mutation { "lastname": "Doe", "company": "Company Name", "street": [ - "320 N Crescent Dr", + "64 Strawberry Dr", "Beverly Hills" ], "city": "Los Angeles", diff --git a/src/guides/v2.3/graphql/tutorials/checkout/checkout-coupon.md b/src/guides/v2.3/graphql/tutorials/checkout/checkout-coupon.md index 58651d7dfbe..0ba6fdc5387 100644 --- a/src/guides/v2.3/graphql/tutorials/checkout/checkout-coupon.md +++ b/src/guides/v2.3/graphql/tutorials/checkout/checkout-coupon.md @@ -20,12 +20,42 @@ Use [applyCouponToCart]({{ page.baseurl }}/graphql/mutations/apply-coupon.html) `{ COUPON_CODE }` is an existing Magento coupon code. It cannot be generated with GraphQL. -**Request:** +## Create a coupon + +Coupons must be generated from the Admin. + +Creating a coupon is described in [Coupon Codes](https://docs.magento.com/user-guide/marketing/price-rules-cart-coupon.html). +For the purpose of this tutorial, create a Cart Price Rule with: + +For **Rule Information**: + +- **Rule Name**: Watch Coupon +- **Active**: Yes +- **Websites**: Main Website +- **Customer Groups**: Select all of them +- **Coupon**: Specific Coupon +- **Coupon Code**: Watch20 +- **Uses per Coupon**: 5 +- **Uses per Customer**: 5 + +For **Actions** + +- **Apply**: Percent of product price discount +- **Discount Amount**: 20 + +Save this rule. +The **Coupon Code** value is the name of the coupon the end user enters. +To verify the coupon works, create an order with a product using guest checkout. +When checking out, enter `Watch20` in the Apply Discount Code field and press the Apply Discount button. +The discount should be applied in the cart. + +When the coupon is set up, we can apply it via GraphQL. Replace the `{ CART_ID }` with your generated ID and replace the `{ COUPON_CODE }` with `Watch20` below. -{:.bs-callout .bs-callout-info} For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. -```text +**Request:** + +```graphql mutation { applyCouponToCart( input: { @@ -49,23 +79,32 @@ mutation { "data": { "applyCouponToCart": { "cart": { - "applied_coupons": { - "code": "{ COUPON_CODE }" - } + "applied_coupons": [ + { + "code": "Watch20" + } + ] } } } } ``` +## Verify this step {#verify-step} + +1. Sign in as a customer to the website using the email `john.doe@example.com` and password `b1b2b3l@w+`. + +1. Go to Checkout. + +1. The discount is displayed in the Order Summary block. + +## Remove a coupon + Use [removeCouponFromCart]({{ page.baseurl }}/graphql/mutations/remove-coupon.html) to remove a discount coupon from the shopping cart. **Request:** -{:.bs-callout .bs-callout-info} -For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. - -```text +```graphql mutation { removeCouponFromCart(input: { cart_id: "{ CART_ID }" }) { cart { @@ -92,11 +131,3 @@ mutation { } } ``` - -## Verify this step {#verify-step} - -1. Sign in as a customer to the website using the email `john.doe@example.com` and password `b1b2b3l@w+`. - -1. Go to Checkout. - -1. The discount is displayed in the Order Summary block. diff --git a/src/guides/v2.3/graphql/tutorials/checkout/checkout-customer.md b/src/guides/v2.3/graphql/tutorials/checkout/checkout-customer.md index 3789f7092bc..d428f0e0c73 100644 --- a/src/guides/v2.3/graphql/tutorials/checkout/checkout-customer.md +++ b/src/guides/v2.3/graphql/tutorials/checkout/checkout-customer.md @@ -14,7 +14,7 @@ contributor_name: Atwix contributor_link: https://www.atwix.com/ --- -This step creates a customer account and generates an authentication token for that customer. You can skip this step if you want to perform this tutorial as a guest user. +This step creates a customer account and generates an authentication token for that customer. You can skip this step if you want to perform this tutorial as a guest user. ## Create a customer @@ -22,7 +22,7 @@ Use the `createCustomer` mutation to register the new customer account in the st **Request:** -```text +```graphql mutation { createCustomer( input: { @@ -68,7 +68,7 @@ To place an order as a customer, you must obtain an authorization token by calli **Request:** -```text +```graphql mutation { generateCustomerToken(email: "john.doe@example.com", password: "b1b2b3l@w+") { token @@ -88,6 +88,11 @@ mutation { } ``` +## Specify an Authorization header + +To send requests on behalf of the customer, you must supply the generated token as a header in your GraphQL browser. +The name of the header is `Authorization` and the value is `Bearer `. + [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) describes the mutation further. ## Verify this step {#verify-step} diff --git a/src/guides/v2.3/graphql/tutorials/checkout/checkout-payment-method.md b/src/guides/v2.3/graphql/tutorials/checkout/checkout-payment-method.md index ebba8a0e3a8..8be733dd0d1 100644 --- a/src/guides/v2.3/graphql/tutorials/checkout/checkout-payment-method.md +++ b/src/guides/v2.3/graphql/tutorials/checkout/checkout-payment-method.md @@ -15,18 +15,17 @@ contributor_link: https://www.atwix.com/ --- {:.bs-callout-tip} -You must always set a payment method. +You must always set a payment method for an order. Use the following `cart` query to determine which payment methods which are available for your order. `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). -**Request:** - -{:.bs-callout-info} For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. -```text +**Request:** + +```graphql query { cart(cart_id: "{ CART_ID }") { available_payment_methods { @@ -54,21 +53,13 @@ query { } ``` -There are two mutation queries in GraphQl which can be use to set the payment method for your order: - -|Mutation|Description| -|--- |--- | -|`setPaymentMethodOnCart`|Sets the payment method for your order.| -|`setPaymentMethodAndPlaceOrder`| **Deprecated** Sets the payment method and then immediately places your order. In this case ["Step 10. Place the order"]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-place-order.html) can be skipped.| - ### Set payment method on cart {#setPaymentMethodOnCart} Use the `setPaymentMethodOnCart` mutation to set the payment method for your order. The value `checkmo` ("Check / Money order" payment method code) was returned in the query. -**Request:** +Send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. -{: .bs-callout-info} -For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. +**Request:** ```graphql mutation { @@ -105,46 +96,6 @@ If the operation is successful, the response contains the code of the selected p } ``` -### Set payment method and place order {#setPaymentMethodAndPlaceOrder} - -Use the `setPaymentMethodAndPlaceOrder` mutation to set the payment method and place the order. - -{:.bs-callout-warning} -The `setPaymentMethodAndPlaceOrder` mutation has been deprecated. - -**Request:** - -```graphql -mutation { - setPaymentMethodAndPlaceOrder(input: { - cart_id: "{ CART_ID }" - payment_method: { - code: "checkmo" - } - }) { - order { - order_id - } - } -} -``` - -**Response:** - -If the operation is successful, the response contains the order ID. - -```json -{ - "data": { - "setPaymentMethodAndPlaceOrder": { - "order": { - "order_id": "000000001" - } - } - } -} -``` - ## Verify this step {#verify-step} 1. Sign in as a customer to the website using the email `john.doe@example.com` and password `b1b2b3l@w+`. diff --git a/src/guides/v2.3/graphql/tutorials/checkout/checkout-place-order.md b/src/guides/v2.3/graphql/tutorials/checkout/checkout-place-order.md index 68fab909f04..c6ed8845b05 100644 --- a/src/guides/v2.3/graphql/tutorials/checkout/checkout-place-order.md +++ b/src/guides/v2.3/graphql/tutorials/checkout/checkout-place-order.md @@ -18,12 +18,11 @@ The `placeOrder` mutation places an order. `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). -**Request:** +Send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. -{:.bs-callout .bs-callout-info} -For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. +**Request:** -```text +```graphql mutation { placeOrder(input: {cart_id: "{ CART_ID }"}) { order { @@ -51,4 +50,4 @@ mutation { 1. Sign in as a customer to the website using the email `john.doe@example.com` and password `b1b2b3l@w+`. -1. Go to **My Account** > **My Orders**. The order you created is displayed. The order is also displayed on the Orders grid (**Sales** > **Orders** in the Magento Admin. +1. Go to **My Account** > **My Orders**. The order you created is displayed. The order is also displayed on the Orders grid (**Sales** > **Orders**) in the Magento Admin. diff --git a/src/guides/v2.3/graphql/tutorials/checkout/checkout-quote-email.md b/src/guides/v2.3/graphql/tutorials/checkout/checkout-quote-email.md index b490fe820f3..cd2b14cd9f7 100644 --- a/src/guides/v2.3/graphql/tutorials/checkout/checkout-quote-email.md +++ b/src/guides/v2.3/graphql/tutorials/checkout/checkout-quote-email.md @@ -23,7 +23,7 @@ If you place an order as a guest user, you must set a quote email address. Use t **Request:** -```text +```graphql mutation { setGuestEmailOnCart(input: { cart_id: "{ CART_ID }" diff --git a/src/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-address.md b/src/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-address.md index b8be2d55e21..e74776b3d86 100644 --- a/src/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-address.md +++ b/src/guides/v2.3/graphql/tutorials/checkout/checkout-shipping-address.md @@ -14,37 +14,33 @@ contributor_name: Atwix contributor_link: https://www.atwix.com/ --- -Use the [setShippingAddressesOnCart]({{ page.baseurl }}/graphql/mutations/set-shipping-address.html) mutation to set a shipping address. You can set the shipping address in the following ways: +Use the [setShippingAddressesOnCart]({{ page.baseurl }}/graphql/mutations/set-shipping-address.html) mutation to set a shipping address. -* Add a new shipping address -* Assign the shipping address to be the same as the billing address -* Use an address already defined in the logged-in customer's address book +## Add shipping address to the cart -## Create a new shipping address +In this step, we use the `setShippingAddressesOnCart` mutation to add a shipping address to the cart. -The following mutation adds a shipping address to the quote. +If using guest checkout, run the following example. -`{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). +If using a logged in customer, send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. **Request:** -{:.bs-callout .bs-callout-info} -For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. - -```text +```graphql mutation { setShippingAddressesOnCart( input: { - cart_id: "{ CART_ID }" + cart_id: "hD5ac9d7N5539DMVhs5uIzwS04hsD3vy" shipping_addresses: [ { address: { firstname: "John" lastname: "Doe" company: "Company Name" - street: ["320 N Crescent Dr", "Beverly Hills"] + street: ["3320 N Crescent Dr", "Beverly Hills"] city: "Los Angeles" region: "CA" + region_id: 12 postcode: "90210" country_code: "US" telephone: "123-456-0000" @@ -71,6 +67,12 @@ mutation { code label } + available_shipping_methods{ + carrier_code + carrier_title + method_code + method_title + } } } } @@ -92,7 +94,7 @@ mutation { "lastname": "Doe", "company": "Company Name", "street": [ - "320 N Crescent Dr", + "3320 N Crescent Dr", "Beverly Hills" ], "city": "Los Angeles", @@ -105,7 +107,21 @@ mutation { "country": { "code": "US", "label": "US" - } + }, + "available_shipping_methods": [ + { + "carrier_code": "flatrate", + "carrier_title": "Flat Rate", + "method_code": "flatrate", + "method_title": "Fixed" + }, + { + "carrier_code": "tablerate", + "carrier_title": "Best Way", + "method_code": "bestway", + "method_title": "Table Rate" + } + ] } ] } @@ -114,130 +130,9 @@ mutation { } ``` -## Assign the shipping address to be the same as the billing address - -[Add a new address for billing and shipping]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-billing-address.html) shows how to do this. - -## Use the existing customer's address - -First, query the customer to return a list of address IDs. - -**Request:** - -```text -query { - customer { - addresses { - id - default_billing - default_shipping - } - } -} -``` - -**Response:** - -```text -{ - "data": { - "customer": { - "addresses": [ - { - "id": 2, - "default_billing": true, - "default_shipping": false - }, - { - "id": 3, - "default_billing": false, - "default_shipping": false - }, - { - "id": 4, - "default_billing": false, - "default_shipping": true - } - ] - } - } -} -``` - -Set `{ CUSTOMER_ADDRESS_ID }` to an `id` returned in the query. - `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). -**Request:** - -```text -mutation { - setShippingAddressesOnCart( - input: { - cart_id: "{ CART_ID }" - shipping_addresses: { - customer_address_id: { CUSTOMER_ADDRESS_ID } - } - } - ) { - cart { - shipping_addresses { - firstname - lastname - company - street - city - region { - code - label - } - postcode - telephone - country - { - code - label - } - } - } - } -} -``` - -**Response:** - -```json -{ - "data": { - "setShippingAddressesOnCart": { - "cart": { - "shipping_addresses": [ - { - "firstname": "John", - "lastname": "Doe", - "company": "Company Name", - "street": [ - "320 N Crescent Dr", - "Beverly Hills" - ], - "city": "Los Angeles", - "region": { - "code": "CA", - "label": "California" - }, - "postcode": "90210", - "telephone": "123-456-0000", - "country": { - "code": "US", - "label": "US" - } - } - ] - } - } - } -} -``` +Note the `available_shipping_methods` in the response. We will use this information in a later step. ## Verify this step {#verify-step} diff --git a/src/guides/v2.3/graphql/tutorials/checkout/checkout-shopping-cart.md b/src/guides/v2.3/graphql/tutorials/checkout/checkout-shopping-cart.md index c1b7e1cc3cc..5b15be9627b 100644 --- a/src/guides/v2.3/graphql/tutorials/checkout/checkout-shopping-cart.md +++ b/src/guides/v2.3/graphql/tutorials/checkout/checkout-shopping-cart.md @@ -13,7 +13,6 @@ functional_areas: contributor_name: Atwix contributor_link: https://www.atwix.com/ --- - The procedure for creating a cart varies for logged-in customers and guests. The `customerCart` query returns the active cart for the logged-in customer. If the cart does not exist, the query creates one. You must specify the customer’s authorization token in the headers. Otherwise, the query fails. ["Get customer authorization token"]({{ page.baseurl }}/graphql/authorization-tokens.html) describes these tokens. @@ -47,6 +46,7 @@ The customer created in the previous step does not have an active cart. The foll ``` In the subsequent tutorial steps, the unique shopping cart identifier `pXVxnNg4PFcK1lD60O5evqF7f4SkiRR1` will be listed as `{ CART_ID }`. +Copy the value of the id attribute. Use this value in subsequent steps wherever the { CART_ID } variable is specified. ## Create a guest cart @@ -71,6 +71,7 @@ mutation { ``` In the subsequent tutorial steps, the unique shopping cart identifier `A7jCcOmUjjCh7MxDIzu1SeqdqETqEa5h` will be listed as `{ CART_ID }`. +Copy the value of the id attribute. Use this value in subsequent steps wherever the { CART_ID } variable is specified. ## Verify this step {#verify-step} diff --git a/src/guides/v2.3/graphql/tutorials/checkout/index.md b/src/guides/v2.3/graphql/tutorials/checkout/index.md index 3a809e060c8..0503f6be8b2 100644 --- a/src/guides/v2.3/graphql/tutorials/checkout/index.md +++ b/src/guides/v2.3/graphql/tutorials/checkout/index.md @@ -16,31 +16,30 @@ contributor_link: https://www.atwix.com/ This tutorial describes how to place an order through GraphQl. Customers can make purchases in two ways: -* As a logged-in user -* As a guest user who does not create an account +- As a logged-in user +- As a guest user who does not create an account The **10-step tutorial** generally takes **30 minutes**. -The checkout process in GraphQl consists of 10 steps. Magento GraphQL is designed to run queries and perform actions on behalf of a customer. Magento GraphQL does not perform backend tasks, such as manage invoices or shipments. +Magento GraphQL is designed to run queries and perform actions on behalf of a customer. Magento GraphQL does not perform backend tasks, such as manage invoices or shipments. ### Before you begin Complete the following prerequisites: -* Install a Magento 2.3.2 instance with sample data. +- Install a Magento 2 instance with sample data. + The sample data defines a functional store, called Luma, that sells fitness clothing and accessories. The store does not provide any sandbox accounts for testing credit card payments, so transactions will be simulated using an offline [payment method](https://glossary.magento.com/payment-method). - The sample data defines a functional store, called Luma, that sells fitness clothing and accessories. The store does not provide any sandbox accounts for testing credit card payments, so transactions will be simulated using an offline [payment method](https://glossary.magento.com/payment-method). +- Install a GraphQl client. You can use any GraphQl client to send calls to Magento. [Altair](https://altair.sirmuel.design/) is a good example. -* Install a GraphQl client. You can use any GraphQl client to send calls to Magento. [GraphiQL](https://electronjs.org/apps/graphiql) is recommended. +- Learn about GraphQL, how it works, and how to use it. See [Introduction to GraphQL](https://graphql.org/learn/) for details. -* Learn about GraphQL, how it works, and how to use it. See [Introduction to GraphQL](https://graphql.org/learn/) for details. +- Know how to generate a customer token. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for details. -* Know how to generate a customer token. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for details. - -* Find the Magento Merchant documentation. Refer to [Getting Started with {{site.data.var.ce}}](http://docs.magento.com/m2/ce/user_guide/getting-started.html) for information about the Luma store that is created when you install Magento with the sample data. +- In the Magento admin, create a [coupon](https://docs.magento.com/user-guide/marketing/price-rules-cart-coupon-code-configure.html) that will be used in [Step 7. Apply a coupon]({{page.baseurl}}/graphql/tutorials/checkout/checkout-coupon.html). ### Other resources -* [Order processing tutorial]({{ page.baseurl }}/rest/tutorials/orders/order-intro.html) shows a system integrator how REST APIs are used in the lifecycle of an order, including configuring a store and creating a customer; creating quotes, orders, invoices, and shipments; preparing for checkout; and more order-related tasks. +- [Order processing tutorial]({{ page.baseurl }}/rest/tutorials/orders/order-intro.html) shows a system integrator how REST APIs are used in the lifecycle of an order, including configuring a store and creating a customer; creating quotes, orders, invoices, and shipments; preparing for checkout; and more order-related tasks. -* [REST Tutorials]({{ page.baseurl }}/rest/tutorials/index.html) provides additional information about completing any Magento REST tutorial. +- [REST Tutorials]({{ page.baseurl }}/rest/tutorials/index.html) provides additional information about completing any Magento REST tutorial. diff --git a/src/guides/v2.4/comp-mgr/cli/cli-rc1-samp.md b/src/guides/v2.4/comp-mgr/cli/cli-rc1-samp.md deleted file mode 120000 index 6d73992e07a..00000000000 --- a/src/guides/v2.4/comp-mgr/cli/cli-rc1-samp.md +++ /dev/null @@ -1 +0,0 @@ -../../../v2.3/comp-mgr/cli/cli-rc1-samp.md \ No newline at end of file diff --git a/src/guides/v2.4/comp-mgr/cli/cli-rc1-samp.md b/src/guides/v2.4/comp-mgr/cli/cli-rc1-samp.md new file mode 100644 index 00000000000..13772a97dd3 --- /dev/null +++ b/src/guides/v2.4/comp-mgr/cli/cli-rc1-samp.md @@ -0,0 +1,8 @@ +--- +group: software-update-guide +title: Command-line upgrade with sample data +functional_areas: + - Upgrade +--- + +{%include install/sampledata/sample-data-rc1-cli-24.md %} \ No newline at end of file diff --git a/src/guides/v2.4/config-guide/cache/two-level-cache.md b/src/guides/v2.4/config-guide/cache/two-level-cache.md index 24e19c5b4bd..32824deb42a 100644 --- a/src/guides/v2.4/config-guide/cache/two-level-cache.md +++ b/src/guides/v2.4/config-guide/cache/two-level-cache.md @@ -20,29 +20,29 @@ Magento stores the hashed data version in Redis, with the suffix ':version' appe ```php 'cache' => [ - [ + 'frontend' => [ 'default' => [ - 'backend' => '\\Magento\\Framework\\Cache\\Backend\\RemoteSynchronizedCache', - 'backend_options' => [ - 'remote_backend' => '\\Magento\\Framework\\Cache\\Backend\\Redis', - 'remote_backend_options' => [ - 'persistent' => 0, - 'server' => 'localhost', - 'database' => '0', - 'port' => '6370', - 'password' => '', - 'compress_data' => '1', - ], - 'local_backend' => 'Cm_Cache_Backend_File', - 'local_backend_options' => [ - 'cache_dir' => '/dev/shm/' - ] - ], - 'frontend_options' => [ - 'write_control' => false, - ], - 'use_stale_cache' => false, - ] + 'backend' => '\\Magento\\Framework\\Cache\\Backend\\RemoteSynchronizedCache', + 'backend_options' => [ + 'remote_backend' => '\\Magento\\Framework\\Cache\\Backend\\Redis', + 'remote_backend_options' => [ + 'persistent' => 0, + 'server' => 'localhost', + 'database' => '0', + 'port' => '6370', + 'password' => '', + 'compress_data' => '1', + ], + 'local_backend' => 'Cm_Cache_Backend_File', + 'local_backend_options' => [ + 'cache_dir' => '/dev/shm/' + ] + ], + 'frontend_options' => [ + 'write_control' => false, + ], + 'use_stale_cache' => false, + ] ], 'type' => [ 'default' => ['frontend' => 'default'], diff --git a/src/guides/v2.4/extension-dev-guide/searching-with-repositories.md b/src/guides/v2.4/extension-dev-guide/searching-with-repositories.md index f3270617ce3..ca484cba989 100644 --- a/src/guides/v2.4/extension-dev-guide/searching-with-repositories.md +++ b/src/guides/v2.4/extension-dev-guide/searching-with-repositories.md @@ -506,3 +506,6 @@ The `di.xml` configuration file excerpt below shows how you can create a virtual ``` + +{:.bs-callout-info} +When building an EAV Model that needs to implement the `Repository::getList` method, use the EAV Filter Processor; otherwise the custom filters will not be added to the collection. diff --git a/src/guides/v2.4/graphql/tutorials/checkout/checkout-shipping-method.md b/src/guides/v2.4/graphql/tutorials/checkout/checkout-shipping-method.md index 881020119eb..41a29eff096 100644 --- a/src/guides/v2.4/graphql/tutorials/checkout/checkout-shipping-method.md +++ b/src/guides/v2.4/graphql/tutorials/checkout/checkout-shipping-method.md @@ -22,21 +22,22 @@ The `setShippingMethodsOnCart` mutation defines the delivery methods for your or `{ CART_ID }` is the unique shopping cart ID from [Step 2. Create empty cart]({{ page.baseurl }}/graphql/tutorials/checkout/checkout-add-product-to-cart.html). -{:.bs-callout .bs-callout-info} +The `carrier_code` and `method_code` values come from the response of the `setShippingAddressesOnCart` mutation on the [Set the shipping address](checkout-shipping-address.html) step. + For logged-in customers, send the customer's authorization token in the `Authorization` parameter of the header. See [Authorization tokens]({{page.baseurl}}/graphql/authorization-tokens.html) for more information. **Request:** -The following mutation query assigns UPS "Ground" method. +The following mutation assigns Table Rate method. -```text +```graphql mutation { setShippingMethodsOnCart(input: { cart_id: "{ CART_ID }" shipping_methods: [ { - carrier_code: "ups" - method_code: "GND" + carrier_code: "tablerate" + method_code: "bestway" } ] }) { @@ -64,10 +65,10 @@ mutation { "shipping_addresses": [ { "selected_shipping_method": { - "carrier_code": "ups", - "method_code": "GND", - "carrier_title": "United Parcel Service", - "method_title": "Ground" + "carrier_code": "tablerate", + "method_code": "bestway", + "carrier_title": "Best Way", + "method_title": "Table Rate" } } ] diff --git a/src/quality-patches/release-notes.md b/src/quality-patches/release-notes.md index 34712ddbb24..16b5d7859c4 100644 --- a/src/quality-patches/release-notes.md +++ b/src/quality-patches/release-notes.md @@ -19,6 +19,17 @@ The [Magento Quality Patches](https://github.com/magento/quality-patches) packag See [Apply patches]({{ site.baseurl }}/guides/v2.4/comp-mgr/patching/mqp.html) for instructions on applying patches to your Magento projects. See [Patches available in MQP tool](https://support.magento.com/hc/en-us/sections/360010506631-Patches-available-in-MQP-tool-) for additional patch details. +## v1.0.12 + +- **MDVA-31399** _(for Magento `>=2.3.2 <2.4.2`)_—Adds the "Subtotal (Incl. Tax)" option to price rule conditions. +- **MDVA-31236** _(for Magento `>=2.4.0 <2.4.2`)_—Fixes the issue where Magento Admins with custom resource access are not able to set up 2FA or log in. +- **MDVA-30845** _(for Magento `>=2.3.5 <2.3.7`)_—Fixes the issue where the "Sorry, no quotes are available for this order at this time" error is displayed when failing to connect to UPS XML/USPS/DHL, and no other shipping method is available. +- **MDVA-32133** _(for Magento `>=2.4.0 <2.4.1`)_—Fixes the issue where media gallery is not loading from Page Builder in certain cases. +- **MDVA-12304** _(for Magento `>=2.3.0 <2.4.2`)_—Increases the maximum number of cookies from 50 to 200. +- **MDVA-32632** _(for Magento `>=2.3.2 <2.3.5`)_—Fixes the issue where orders appear in the payment system, but not in Magento. +- **MDVA-32449** _(for Magento `>=2.3.0 <2.3.6 || 2.4.0 || >=2.4.1 <2.4.2` with B2B extension)_—Fixes the issue where the order history loads very slowly or does not load at all. +- **MDVA-32739** _(for Magento `>=2.3.0 <2.4.2`)_—Fixes the issue where enabling Asynchronous Email Notifications sends out old sales emails. + ## v1.0.11 - **MC-38509** _(for Magento `2.3.6, 2.4.1`)_—Fixes the issue where the "Create an Account" button stays disabled after correcting invalid data in the "Create New Customer Account" form. diff --git a/src/redoc/2.2/index.html b/src/redoc/2.2/index.html new file mode 100644 index 00000000000..3c714d211c5 --- /dev/null +++ b/src/redoc/2.2/index.html @@ -0,0 +1,5 @@ +--- +layout: redoc +specUrl: latest-2.2.schema.json +redirect_from: swagger/index.html +--- diff --git a/src/redoc/2.2/latest-2.2.schema.json b/src/redoc/2.2/latest-2.2.schema.json new file mode 100644 index 00000000000..cd46a776002 --- /dev/null +++ b/src/redoc/2.2/latest-2.2.schema.json @@ -0,0 +1 @@ +{"swagger":"2.0","info":{"version":"2.2.10","title":"Magento B2B"},"host":"example.com","basePath":"/rest/default","schemes":["https"],"tags":[{"name":"addresses/{addressId}"},{"name":"amazon-billing-address/{amazonOrderReferenceId}"},{"name":"amazon-shipping-address/{amazonOrderReferenceId}"},{"name":"amazon/order-ref"},{"name":"analytics/link"},{"name":"attributeMetadata/customer"},{"name":"attributeMetadata/customer/attribute/{attributeCode}"},{"name":"attributeMetadata/customer/custom"},{"name":"attributeMetadata/customer/form/{formCode}"},{"name":"attributeMetadata/customerAddress"},{"name":"attributeMetadata/customerAddress/attribute/{attributeCode}"},{"name":"attributeMetadata/customerAddress/custom"},{"name":"attributeMetadata/customerAddress/form/{formCode}"},{"name":"bulk/{bulkUuid}/detailed-status"},{"name":"bulk/{bulkUuid}/operation-status/{status}"},{"name":"bulk/{bulkUuid}/status"},{"name":"bundle-products/{productSku}/children"},{"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/{sku}/options/all"},{"name":"bundle-products/options/{optionId}"},{"name":"bundle-products/options/add"},{"name":"bundle-products/options/types"},{"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"},{"name":"carts/{cartId}/items/{itemId}"},{"name":"carts/{cartId}/order"},{"name":"carts/{cartId}/payment-methods"},{"name":"carts/{cartId}/selected-payment-method"},{"name":"carts/{cartId}/shipping-information"},{"name":"carts/{cartId}/shipping-methods"},{"name":"carts/{cartId}/totals"},{"name":"carts/{cartId}/totals-information"},{"name":"carts/{quoteId}/giftCards"},{"name":"carts/{quoteId}/items"},{"name":"carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}"},{"name":"carts/guest-carts/{cartId}/giftCards"},{"name":"carts/guest-carts/{cartId}/giftCards/{giftCardCode}"},{"name":"carts/licence"},{"name":"carts/mine"},{"name":"carts/mine/balance/apply"},{"name":"carts/mine/balance/unapply"},{"name":"carts/mine/billing-address"},{"name":"carts/mine/checkGiftCard/{giftCardCode}"},{"name":"carts/mine/checkout-fields"},{"name":"carts/mine/collect-totals"},{"name":"carts/mine/collection-point/search-request"},{"name":"carts/mine/collection-point/search-result"},{"name":"carts/mine/collection-point/select"},{"name":"carts/mine/coupons"},{"name":"carts/mine/coupons/{couponCode}"},{"name":"carts/mine/delivery-option"},{"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/payment-methods"},{"name":"carts/mine/selected-payment-method"},{"name":"carts/mine/set-payment-information"},{"name":"carts/mine/shipping-information"},{"name":"carts/mine/shipping-methods"},{"name":"carts/mine/totals"},{"name":"carts/mine/totals-information"},{"name":"carts/search"},{"name":"categories"},{"name":"categories/{categoryId}"},{"name":"categories/{categoryId}/move"},{"name":"categories/{categoryId}/products"},{"name":"categories/{categoryId}/products/{sku}"},{"name":"categories/{id}"},{"name":"categories/attributes"},{"name":"categories/attributes/{attributeCode}"},{"name":"categories/attributes/{attributeCode}/options"},{"name":"categories/list"},{"name":"cmsBlock"},{"name":"cmsBlock/{blockId}"},{"name":"cmsBlock/{id}"},{"name":"cmsBlock/search"},{"name":"cmsPage"},{"name":"cmsPage/{id}"},{"name":"cmsPage/{pageId}"},{"name":"cmsPage/search"},{"name":"company/"},{"name":"company/{companyId}"},{"name":"company/assignRoles"},{"name":"company/role/"},{"name":"company/role/{id}"},{"name":"company/role/{roleId}"},{"name":"company/role/{roleId}/users"},{"name":"companyCredits/"},{"name":"companyCredits/{creditId}"},{"name":"companyCredits/{creditId}/decreaseBalance"},{"name":"companyCredits/{creditId}/increaseBalance"},{"name":"companyCredits/{id}"},{"name":"companyCredits/company/{companyId}"},{"name":"companyCredits/history"},{"name":"companyCredits/history/{historyId}"},{"name":"configurable-products/{sku}/child"},{"name":"configurable-products/{sku}/children"},{"name":"configurable-products/{sku}/children/{childSku}"},{"name":"configurable-products/{sku}/options"},{"name":"configurable-products/{sku}/options/{id}"},{"name":"configurable-products/{sku}/options/all"},{"name":"configurable-products/variation"},{"name":"coupons"},{"name":"coupons/{couponId}"},{"name":"coupons/deleteByCodes"},{"name":"coupons/deleteByIds"},{"name":"coupons/generate"},{"name":"coupons/search"},{"name":"creditmemo"},{"name":"creditmemo/{id}"},{"name":"creditmemo/{id}/comments"},{"name":"creditmemo/{id}/emails"},{"name":"creditmemo/refund"},{"name":"creditmemos"},{"name":"customerGroups"},{"name":"customerGroups/{id}"},{"name":"customerGroups/{id}/permissions"},{"name":"customerGroups/default"},{"name":"customerGroups/default/{id}"},{"name":"customerGroups/default/{storeId}"},{"name":"customerGroups/search"},{"name":"customers"},{"name":"customers/{customerId}"},{"name":"customers/{customerId}/billingAddress"},{"name":"customers/{customerId}/carts"},{"name":"customers/{customerId}/confirm"},{"name":"customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}"},{"name":"customers/{customerId}/permissions/readonly"},{"name":"customers/{customerId}/shippingAddress"},{"name":"customers/{email}/activate"},{"name":"customers/addresses/{addressId}"},{"name":"customers/confirm"},{"name":"customers/isEmailAvailable"},{"name":"customers/me"},{"name":"customers/me/activate"},{"name":"customers/me/billingAddress"},{"name":"customers/me/password"},{"name":"customers/me/shippingAddress"},{"name":"customers/password"},{"name":"customers/resetPassword"},{"name":"customers/search"},{"name":"customers/validate"},{"name":"directory/countries"},{"name":"directory/countries/{countryId}"},{"name":"directory/currency"},{"name":"eav/attribute-sets"},{"name":"eav/attribute-sets/{attributeSetId}"},{"name":"eav/attribute-sets/list"},{"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}/checkout-fields"},{"name":"guest-carts/{cartId}/collect-totals"},{"name":"guest-carts/{cartId}/collection-point/search-request"},{"name":"guest-carts/{cartId}/collection-point/search-result"},{"name":"guest-carts/{cartId}/collection-point/select"},{"name":"guest-carts/{cartId}/coupons"},{"name":"guest-carts/{cartId}/coupons/{couponCode}"},{"name":"guest-carts/{cartId}/delivery-option"},{"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}/payment-methods"},{"name":"guest-carts/{cartId}/selected-payment-method"},{"name":"guest-carts/{cartId}/set-payment-information"},{"name":"guest-carts/{cartId}/shipping-information"},{"name":"guest-carts/{cartId}/shipping-methods"},{"name":"guest-carts/{cartId}/totals"},{"name":"guest-carts/{cartId}/totals-information"},{"name":"guest-giftregistry/{cartId}/estimate-shipping-methods"},{"name":"hierarchy/{id}"},{"name":"hierarchy/move/{id}"},{"name":"integration/admin/token"},{"name":"integration/customer/token"},{"name":"invoice/{invoiceId}/refund"},{"name":"invoices"},{"name":"invoices/"},{"name":"invoices/{id}"},{"name":"invoices/{id}/capture"},{"name":"invoices/{id}/comments"},{"name":"invoices/{id}/emails"},{"name":"invoices/{id}/void"},{"name":"invoices/comments"},{"name":"modules"},{"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":"negotiable-carts/{cartId}/totals"},{"name":"negotiableQuote/{quoteId}"},{"name":"negotiableQuote/{quoteId}/comments"},{"name":"negotiableQuote/{quoteId}/shippingMethod"},{"name":"negotiableQuote/attachmentContent"},{"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/"},{"name":"orders/{id}"},{"name":"orders/{id}/cancel"},{"name":"orders/{id}/comments"},{"name":"orders/{id}/emails"},{"name":"orders/{id}/hold"},{"name":"orders/{id}/statuses"},{"name":"orders/{id}/unhold"},{"name":"orders/{parent_id}"},{"name":"orders/create"},{"name":"orders/items"},{"name":"orders/items/{id}"},{"name":"products"},{"name":"products-render-info"},{"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"},{"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}"},{"name":"products/{sku}/links/{type}/{linkedProductSku}"},{"name":"products/{sku}/media"},{"name":"products/{sku}/media/{entryId}"},{"name":"products/{sku}/options"},{"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"},{"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/attribute-sets/groups/list"},{"name":"products/attribute-sets/sets/list"},{"name":"products/attributes"},{"name":"products/attributes/{attributeCode}"},{"name":"products/attributes/{attributeCode}/options"},{"name":"products/attributes/{attributeCode}/options/{optionId}"},{"name":"products/attributes/types"},{"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/links/{type}/attributes"},{"name":"products/links/types"},{"name":"products/media/types/{attributeSetName}"},{"name":"products/options"},{"name":"products/options/{optionId}"},{"name":"products/options/types"},{"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":"products/types"},{"name":"requisition_lists"},{"name":"returns"},{"name":"returns/{id}"},{"name":"returns/{id}/comments"},{"name":"returns/{id}/labels"},{"name":"returns/{id}/tracking-numbers"},{"name":"returns/{id}/tracking-numbers/{trackId}"},{"name":"returnsAttributeMetadata"},{"name":"returnsAttributeMetadata/{attributeCode}"},{"name":"returnsAttributeMetadata/custom"},{"name":"returnsAttributeMetadata/form/{formCode}"},{"name":"reward/mine/use-reward"},{"name":"salesRules"},{"name":"salesRules/{ruleId}"},{"name":"salesRules/search"},{"name":"search"},{"name":"sharedCatalog"},{"name":"sharedCatalog/"},{"name":"sharedCatalog/{id}"},{"name":"sharedCatalog/{id}/assignCategories"},{"name":"sharedCatalog/{id}/assignProducts"},{"name":"sharedCatalog/{id}/categories"},{"name":"sharedCatalog/{id}/products"},{"name":"sharedCatalog/{id}/unassignCategories"},{"name":"sharedCatalog/{id}/unassignProducts"},{"name":"sharedCatalog/{sharedCatalogId}"},{"name":"sharedCatalog/{sharedCatalogId}/assignCompanies"},{"name":"sharedCatalog/{sharedCatalogId}/companies"},{"name":"sharedCatalog/{sharedCatalogId}/unassignCompanies"},{"name":"shipment/"},{"name":"shipment/{id}"},{"name":"shipment/{id}/comments"},{"name":"shipment/{id}/emails"},{"name":"shipment/{id}/label"},{"name":"shipment/track"},{"name":"shipment/track/{id}"},{"name":"shipments"},{"name":"stockItems/{productSku}"},{"name":"stockItems/lowStock/"},{"name":"stockStatuses/{productSku}"},{"name":"store/storeConfigs"},{"name":"store/storeGroups"},{"name":"store/storeViews"},{"name":"store/websites"},{"name":"taxClasses"},{"name":"taxClasses/{classId}"},{"name":"taxClasses/{taxClassId}"},{"name":"taxClasses/search"},{"name":"taxRates"},{"name":"taxRates/{rateId}"},{"name":"taxRates/search"},{"name":"taxRules"},{"name":"taxRules/{ruleId}"},{"name":"taxRules/search"},{"name":"team/"},{"name":"team/{companyId}"},{"name":"team/{teamId}"},{"name":"temando/rma/{rmaId}/shipments"},{"name":"transactions"},{"name":"transactions/{id}"},{"name":"worldpay-guest-carts/{cartId}/payment-information"}],"paths":{"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"addresses/{addressId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"string"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"amazon-billing-address/{amazonOrderReferenceId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"string"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"amazon-shipping-address/{amazonOrderReferenceId}"}},"/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"}},"/V1/analytics/link":{"get":{"tags":["analytics/link"],"description":"","operationId":"analyticsLinkProviderV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/analytics-data-link-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"analytics/link"}},"/V1/attributeMetadata/customer":{"get":{"tags":["attributeMetadata/customer"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"attributeMetadata/customer"}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["attributeMetadata/customer/attribute/{attributeCode}"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"attributeMetadata/customer/attribute/{attributeCode}"}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["attributeMetadata/customer/custom"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"attributeMetadata/customer/custom"}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["attributeMetadata/customer/form/{formCode}"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"attributeMetadata/customer/form/{formCode}"}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["attributeMetadata/customerAddress"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"attributeMetadata/customerAddress"}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["attributeMetadata/customerAddress/attribute/{attributeCode}"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"attributeMetadata/customerAddress/attribute/{attributeCode}"}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["attributeMetadata/customerAddress/custom"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"attributeMetadata/customerAddress/custom"}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["attributeMetadata/customerAddress/form/{formCode}"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"attributeMetadata/customerAddress/form/{formCode}"}},"/V1/bulk/{bulkUuid}/detailed-status":{"get":{"tags":["bulk/{bulkUuid}/detailed-status"],"description":"Get Bulk summary data with list of operations items full data.","operationId":"asynchronousOperationsBulkStatusV1GetBulkDetailedStatusGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"bulkUuid","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/asynchronous-operations-data-detailed-bulk-operations-status-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bulk/{bulkUuid}/detailed-status"}},"/V1/bulk/{bulkUuid}/operation-status/{status}":{"get":{"tags":["bulk/{bulkUuid}/operation-status/{status}"],"description":"Get operations count by bulk uuid and status.","operationId":"asynchronousOperationsBulkStatusV1GetOperationsCountByBulkIdAndStatusGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"bulkUuid","in":"path","type":"string","required":true},{"name":"status","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bulk/{bulkUuid}/operation-status/{status}"}},"/V1/bulk/{bulkUuid}/status":{"get":{"tags":["bulk/{bulkUuid}/status"],"description":"Get Bulk summary data with list of operations items short data.","operationId":"asynchronousOperationsBulkStatusV1GetBulkShortStatusGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"bulkUuid","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/asynchronous-operations-data-bulk-operations-status-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bulk/{bulkUuid}/status"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/options/add"}},"/V1/bundle-products/options/types":{"get":{"tags":["bundle-products/options/types"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/options/types"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/options/{optionId}"}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundle-products/{productSku}/children"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/{productSku}/children"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/{sku}/links/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/{sku}/links/{optionId}"}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundle-products/{sku}/options/all"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/{sku}/options/all"}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundle-products/{sku}/options/{optionId}"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"bundle-products/{sku}/options/{optionId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/"}},"/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}":{"get":{"tags":["carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet","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":{"200":{"description":"200 Success.","schema":{"type":"number"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}"}},"/V1/carts/guest-carts/{cartId}/giftCards":{"post":{"tags":["carts/guest-carts/{cartId}/giftCards"],"description":"","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/guest-carts/{cartId}/giftCards"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/guest-carts/{cartId}/giftCards/{giftCardCode}"}},"/V1/carts/licence":{"get":{"tags":["carts/licence"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/licence"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"new cart ID if customer did not have a cart or ID of the existing cart otherwise."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine"},"get":{"tags":["carts/mine"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine"}},"/V1/carts/mine/balance/apply":{"post":{"tags":["carts/mine/balance/apply"],"description":"Apply store credit.","operationId":"customerBalanceBalanceManagementFromQuoteV1ApplyPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/balance/apply"}},"/V1/carts/mine/balance/unapply":{"post":{"tags":["carts/mine/balance/unapply"],"description":"Unapply store credit.","operationId":"customerBalanceBalanceManagementFromQuoteV1UnapplyPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/balance/unapply"}},"/V1/carts/mine/billing-address":{"get":{"tags":["carts/mine/billing-address"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/billing-address"}},"/V1/carts/mine/checkGiftCard/{giftCardCode}":{"get":{"tags":["carts/mine/checkGiftCard/{giftCardCode}"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/checkGiftCard/{giftCardCode}"}},"/V1/carts/mine/checkout-fields":{"post":{"tags":["carts/mine/checkout-fields"],"description":"","operationId":"temandoShippingQuoteCartCheckoutFieldManagementV1SaveCheckoutFieldsPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"temandoShippingQuoteCartCheckoutFieldManagementV1SaveCheckoutFieldsPostBody","in":"body","schema":{"required":["serviceSelection"],"properties":{"serviceSelection":{"type":"array","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/checkout-fields"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/collect-totals"}},"/V1/carts/mine/collection-point/search-request":{"put":{"tags":["carts/mine/collection-point/search-request"],"description":"","operationId":"temandoShippingCollectionPointCartCollectionPointManagementV1SaveSearchRequestPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"temandoShippingCollectionPointCartCollectionPointManagementV1SaveSearchRequestPutBody","in":"body","schema":{"required":["countryId","postcode"],"properties":{"countryId":{"type":"string"},"postcode":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/temando-shipping-data-collection-point-search-request-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/collection-point/search-request"},"delete":{"tags":["carts/mine/collection-point/search-request"],"description":"","operationId":"temandoShippingCollectionPointCartCollectionPointManagementV1DeleteSearchRequestDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/collection-point/search-request"}},"/V1/carts/mine/collection-point/search-result":{"get":{"tags":["carts/mine/collection-point/search-result"],"description":"","operationId":"temandoShippingCollectionPointCartCollectionPointManagementV1GetCollectionPointsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/temando-shipping-data-collection-point-quote-collection-point-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/collection-point/search-result"}},"/V1/carts/mine/collection-point/select":{"post":{"tags":["carts/mine/collection-point/select"],"description":"","operationId":"temandoShippingCollectionPointCartCollectionPointManagementV1SelectCollectionPointPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"temandoShippingCollectionPointCartCollectionPointManagementV1SelectCollectionPointPostBody","in":"body","schema":{"required":["entityId"],"properties":{"entityId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/collection-point/select"}},"/V1/carts/mine/coupons":{"get":{"tags":["carts/mine/coupons"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/coupons"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/coupons/{couponCode}"}},"/V1/carts/mine/delivery-option":{"post":{"tags":["carts/mine/delivery-option"],"description":"Handle selected delivery option.","operationId":"temandoShippingQuoteCartDeliveryOptionManagementV1SavePost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"temandoShippingQuoteCartDeliveryOptionManagementV1SavePostBody","in":"body","schema":{"required":["selectedOption"],"properties":{"selectedOption":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/delivery-option"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-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"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-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"}},"/V1/carts/mine/gift-message":{"get":{"tags":["carts/mine/gift-message"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/gift-message"}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["carts/mine/gift-message/{itemId}"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/gift-message/{itemId}"}},"/V1/carts/mine/giftCards":{"post":{"tags":["carts/mine/giftCards"],"description":"","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/giftCards"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/giftCards/{giftCardCode}"}},"/V1/carts/mine/items":{"get":{"tags":["carts/mine/items"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/items"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/items/{itemId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/order"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/payment-information"},"get":{"tags":["carts/mine/payment-information"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/payment-information"}},"/V1/carts/mine/payment-methods":{"get":{"tags":["carts/mine/payment-methods"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/payment-methods"}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["carts/mine/selected-payment-method"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/selected-payment-method"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/set-payment-information"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/shipping-information"}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["carts/mine/shipping-methods"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/shipping-methods"}},"/V1/carts/mine/totals":{"get":{"tags":["carts/mine/totals"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/totals"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/mine/totals-information"}},"/V1/carts/search":{"get":{"tags":["carts/search"],"description":"Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteCartRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/search"}},"/V1/carts/{cartId}":{"get":{"tags":["carts/{cartId}"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}"}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["carts/{cartId}/billing-address"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/billing-address"}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["carts/{cartId}/coupons"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/coupons"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/coupons/{couponCode}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-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"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-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"}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["carts/{cartId}/gift-message"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/gift-message"}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["carts/{cartId}/gift-message/{itemId}"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","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":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/gift-message/{itemId}"}},"/V1/carts/{cartId}/giftCards":{"put":{"tags":["carts/{cartId}/giftCards"],"description":"","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/giftCards"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/giftCards/{giftCardCode}"}},"/V1/carts/{cartId}/items":{"get":{"tags":["carts/{cartId}/items"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/items"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/items/{itemId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/order"}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["carts/{cartId}/payment-methods"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/payment-methods"}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["carts/{cartId}/selected-payment-method"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/selected-payment-method"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/shipping-information"}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["carts/{cartId}/shipping-methods"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/shipping-methods"}},"/V1/carts/{cartId}/totals":{"get":{"tags":["carts/{cartId}/totals"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/totals"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{cartId}/totals-information"}},"/V1/carts/{quoteId}/giftCards":{"get":{"tags":["carts/{quoteId}/giftCards"],"description":"Return GiftCard Account cards","operationId":"giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{quoteId}/giftCards"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"carts/{quoteId}/items"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories"},"get":{"tags":["categories"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories"}},"/V1/categories/attributes":{"get":{"tags":["categories/attributes"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/attributes"}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["categories/attributes/{attributeCode}"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/attributes/{attributeCode}"}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["categories/attributes/{attributeCode}/options"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/attributes/{attributeCode}/options"}},"/V1/categories/list":{"get":{"tags":["categories/list"],"description":"Get category list","operationId":"catalogCategoryListV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/list"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{categoryId}"},"get":{"tags":["categories/{categoryId}"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{categoryId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{categoryId}/move"}},"/V1/categories/{categoryId}/products":{"get":{"tags":["categories/{categoryId}/products"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{categoryId}/products"}},"/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":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{categoryId}/products/{sku}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"categories/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsBlock"}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlock/search"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsBlock/search"}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlock/{blockId}"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsBlock/{blockId}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsBlock/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsPage"}},"/V1/cmsPage/search":{"get":{"tags":["cmsPage/search"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsPage/search"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsPage/{id}"}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPage/{pageId}"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"cmsPage/{pageId}"}},"/V1/company/":{"get":{"tags":["company/"],"description":"Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included.","operationId":"companyCompanyRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/assignRoles"}},"/V1/company/role/":{"get":{"tags":["company/role/"],"description":"Returns the list of roles and permissions for a specified company.","operationId":"companyRoleRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/role/"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/role/{id}"}},"/V1/company/role/{roleId}":{"get":{"tags":["company/role/{roleId}"],"description":"Returns the list of permissions for a specified role.","operationId":"companyRoleRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/role/{roleId}"}},"/V1/company/role/{roleId}/users":{"get":{"tags":["company/role/{roleId}/users"],"description":"View the list of company users assigned to a specified role.","operationId":"companyAclV1GetUsersByRoleIdGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-customer-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/role/{roleId}/users"}},"/V1/company/{companyId}":{"get":{"tags":["company/{companyId}"],"description":"Returns company details.","operationId":"companyCompanyRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"company/{companyId}"}},"/V1/companyCredits/":{"get":{"tags":["companyCredits/"],"description":"Returns the list of credits for specified companies.","operationId":"companyCreditCreditLimitRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/"}},"/V1/companyCredits/company/{companyId}":{"get":{"tags":["companyCredits/company/{companyId}"],"description":"Returns data on the credit limit for a specified company.","operationId":"companyCreditCreditLimitManagementV1GetCreditByCompanyIdGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/company/{companyId}"}},"/V1/companyCredits/history":{"get":{"tags":["companyCredits/history"],"description":"Returns the credit history for one or more companies.","operationId":"companyCreditCreditHistoryManagementV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-history-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/history"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/history/{historyId}"}},"/V1/companyCredits/{creditId}":{"get":{"tags":["companyCredits/{creditId}"],"description":"Returns data on the credit limit for a specified credit limit ID.","operationId":"companyCreditCreditLimitRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"reload","in":"query","type":"boolean","description":"[optional]","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/{creditId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/{creditId}/decreaseBalance"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/{creditId}/increaseBalance"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"companyCredits/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/variation"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/{sku}/child"}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurable-products/{sku}/children"],"description":"Get all children for Configurable product","operationId":"configurableProductLinkManagementV1GetChildrenGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/{sku}/children"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/{sku}/children/{childSku}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/{sku}/options"}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurable-products/{sku}/options/all"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/{sku}/options/all"}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurable-products/{sku}/options/{id}"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"configurable-products/{sku}/options/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons/deleteByCodes"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons/deleteByIds"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons/generate"}},"/V1/coupons/search":{"get":{"tags":["coupons/search"],"description":"Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleCouponRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons/search"}},"/V1/coupons/{couponId}":{"get":{"tags":["coupons/{couponId}"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"coupons/{couponId}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemo"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemo/refund"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemo/{id}"},"get":{"tags":["creditmemo/{id}"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemo/{id}"}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["creditmemo/{id}/comments"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemo/{id}/comments"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemo/{id}/emails"}},"/V1/creditmemos":{"get":{"tags":["creditmemos"],"description":"Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesCreditmemoRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"creditmemos"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customerGroups"}},"/V1/customerGroups/default":{"get":{"tags":["customerGroups/default"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customerGroups/default"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customerGroups/default/{id}"}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroups/default/{storeId}"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customerGroups/default/{storeId}"}},"/V1/customerGroups/search":{"get":{"tags":["customerGroups/search"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerGroupRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customerGroups/search"}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroups/{id}"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customerGroups/{id}"}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroups/{id}/permissions"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customerGroups/{id}/permissions"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers"}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customers/addresses/{addressId}"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/addresses/{addressId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/confirm"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/isEmailAvailable"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/me"},"get":{"tags":["customers/me"],"description":"Get customer by Customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/me"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/me/activate"}},"/V1/customers/me/billingAddress":{"get":{"tags":["customers/me/billingAddress"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/me/billingAddress"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/me/password"}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customers/me/shippingAddress"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/me/shippingAddress"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/password"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/resetPassword"}},"/V1/customers/search":{"get":{"tags":["customers/search"],"description":"Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerCustomerRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/search"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/validate"}},"/V1/customers/{customerId}":{"get":{"tags":["customers/{customerId}"],"description":"Get customer by Customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{customerId}"}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customers/{customerId}/billingAddress"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{customerId}/billingAddress"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"new cart ID if customer did not have a cart or ID of the existing cart otherwise."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{customerId}/carts"}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customers/{customerId}/confirm"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{customerId}/confirm"}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"If 0 is given then a customer will be matched by the RP token."},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}"}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customers/{customerId}/permissions/readonly"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{customerId}/permissions/readonly"}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customers/{customerId}/shippingAddress"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{customerId}/shippingAddress"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"customers/{email}/activate"}},"/V1/directory/countries":{"get":{"tags":["directory/countries"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"directory/countries"}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directory/countries/{countryId}"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"directory/countries/{countryId}"}},"/V1/directory/currency":{"get":{"tags":["directory/currency"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"directory/currency"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"eav/attribute-sets"}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eav/attribute-sets/list"],"description":"Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"eavAttributeSetRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"eav/attribute-sets/list"}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eav/attribute-sets/{attributeSetId}"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"eav/attribute-sets/{attributeSetId}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"gift-wrappings"},"get":{"tags":["gift-wrappings"],"description":"Return list of gift wrapping data objects based on search criteria","operationId":"giftWrappingWrappingRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"gift-wrappings"}},"/V1/gift-wrappings/{id}":{"get":{"tags":["gift-wrappings/{id}"],"description":"Return data object for specified wrapping ID and store.","operationId":"giftWrappingWrappingRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"gift-wrappings/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"gift-wrappings/{wrappingId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"giftregistry/mine/estimate-shipping-methods"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts"}},"/V1/guest-carts/{cartId}":{"get":{"tags":["guest-carts/{cartId}"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}"}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["guest-carts/{cartId}/billing-address"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/billing-address"}},"/V1/guest-carts/{cartId}/checkout-fields":{"post":{"tags":["guest-carts/{cartId}/checkout-fields"],"description":"","operationId":"temandoShippingQuoteGuestCartCheckoutFieldManagementV1SaveCheckoutFieldsPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"temandoShippingQuoteGuestCartCheckoutFieldManagementV1SaveCheckoutFieldsPostBody","in":"body","schema":{"required":["serviceSelection"],"properties":{"serviceSelection":{"type":"array","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/checkout-fields"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/collect-totals"}},"/V1/guest-carts/{cartId}/collection-point/search-request":{"put":{"tags":["guest-carts/{cartId}/collection-point/search-request"],"description":"","operationId":"temandoShippingCollectionPointGuestCartCollectionPointManagementV1SaveSearchRequestPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"temandoShippingCollectionPointGuestCartCollectionPointManagementV1SaveSearchRequestPutBody","in":"body","schema":{"required":["countryId","postcode"],"properties":{"countryId":{"type":"string"},"postcode":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/temando-shipping-data-collection-point-search-request-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/collection-point/search-request"},"delete":{"tags":["guest-carts/{cartId}/collection-point/search-request"],"description":"","operationId":"temandoShippingCollectionPointGuestCartCollectionPointManagementV1DeleteSearchRequestDelete","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/collection-point/search-request"}},"/V1/guest-carts/{cartId}/collection-point/search-result":{"get":{"tags":["guest-carts/{cartId}/collection-point/search-result"],"description":"","operationId":"temandoShippingCollectionPointGuestCartCollectionPointManagementV1GetCollectionPointsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/temando-shipping-data-collection-point-quote-collection-point-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/collection-point/search-result"}},"/V1/guest-carts/{cartId}/collection-point/select":{"post":{"tags":["guest-carts/{cartId}/collection-point/select"],"description":"","operationId":"temandoShippingCollectionPointGuestCartCollectionPointManagementV1SelectCollectionPointPost","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"temandoShippingCollectionPointGuestCartCollectionPointManagementV1SelectCollectionPointPostBody","in":"body","schema":{"required":["entityId"],"properties":{"entityId":{"type":"integer"}},"type":"object","xml":{"name":"request"}}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/collection-point/select"}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["guest-carts/{cartId}/coupons"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/coupons"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/coupons/{couponCode}"}},"/V1/guest-carts/{cartId}/delivery-option":{"post":{"tags":["guest-carts/{cartId}/delivery-option"],"description":"Handle selected delivery option.","operationId":"temandoShippingQuoteGuestCartDeliveryOptionManagementV1SavePost","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":"temandoShippingQuoteGuestCartDeliveryOptionManagementV1SavePostBody","in":"body","schema":{"required":["selectedOption"],"properties":{"selectedOption":{"type":"string"}},"type":"object","xml":{"name":"request"}}}],"responses":{"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/delivery-option"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/estimate-shipping-methods"}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["guest-carts/{cartId}/gift-message"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/gift-message"}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["guest-carts/{cartId}/gift-message/{itemId}"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","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":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/gift-message/{itemId}"}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["guest-carts/{cartId}/items"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/items"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/items/{itemId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/order"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/payment-information"},"get":{"tags":["guest-carts/{cartId}/payment-information"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/payment-information"}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["guest-carts/{cartId}/payment-methods"],"description":"List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/payment-methods"}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["guest-carts/{cartId}/selected-payment-method"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/selected-payment-method"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/set-payment-information"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/shipping-information"}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["guest-carts/{cartId}/shipping-methods"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/shipping-methods"}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["guest-carts/{cartId}/totals"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/totals"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-carts/{cartId}/totals-information"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"guest-giftregistry/{cartId}/estimate-shipping-methods"}},"/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}"}},"/V1/hierarchy/{id}":{"get":{"tags":["hierarchy/{id}"],"description":"Returns the list of teams and company users in the company structure.","operationId":"companyCompanyHierarchyV1GetCompanyHierarchyGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/company-data-hierarchy-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"hierarchy/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"integration/admin/token"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"integration/customer/token"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoice/{invoiceId}/refund"}},"/V1/invoices":{"get":{"tags":["invoices"],"description":"Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesInvoiceRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/comments"}},"/V1/invoices/{id}":{"get":{"tags":["invoices/{id}"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/{id}/capture"}},"/V1/invoices/{id}/comments":{"get":{"tags":["invoices/{id}/comments"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/{id}/comments"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/{id}/emails"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"invoices/{id}/void"}},"/V1/modules":{"get":{"tags":["modules"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"modules"}},"/V1/negotiable-carts/{cartId}/billing-address":{"get":{"tags":["negotiable-carts/{cartId}/billing-address"],"description":"Returns the billing address for a specified quote.","operationId":"negotiableQuoteBillingAddressManagementV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/billing-address"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/coupons"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/coupons/{couponCode}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-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"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-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"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/giftCards"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/giftCards/{giftCardCode}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/payment-information"},"get":{"tags":["negotiable-carts/{cartId}/payment-information"],"description":"Get payment information","operationId":"negotiableQuotePaymentInformationManagementV1GetPaymentInformationGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-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"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-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"}},"/V1/negotiable-carts/{cartId}/totals":{"get":{"tags":["negotiable-carts/{cartId}/totals"],"description":"Returns quote totals data for a specified cart.","operationId":"negotiableQuoteCartTotalRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiable-carts/{cartId}/totals"}},"/V1/negotiableQuote/attachmentContent":{"get":{"tags":["negotiableQuote/attachmentContent"],"description":"Returns content for one or more files attached on the quote comment.","operationId":"negotiableQuoteAttachmentContentManagementV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attachmentIds","in":"query","type":"array","items":{"type":"integer"},"required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/negotiable-quote-data-attachment-content-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/attachmentContent"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/decline"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/pricesUpdated"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/request"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/submitToCustomer"}},"/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}"}},"/V1/negotiableQuote/{quoteId}/comments":{"get":{"tags":["negotiableQuote/{quoteId}/comments"],"description":"Returns comments for a specified negotiable quote.","operationId":"negotiableQuoteCommentLocatorV1GetListForQuoteGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"quoteId","in":"path","type":"integer","required":true,"description":"Negotiable Quote ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of quote comments.","items":{"$ref":"#/definitions/negotiable-quote-data-comment-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/{quoteId}/comments"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"negotiableQuote/{quoteId}/shippingMethod"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"order/{orderId}/invoice"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"order/{orderId}/refund"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Id of created Shipment."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"order/{orderId}/ship"}},"/V1/orders":{"get":{"tags":["orders"],"description":"Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/create"}},"/V1/orders/items":{"get":{"tags":["orders/items"],"description":"Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderItemRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/items"}},"/V1/orders/items/{id}":{"get":{"tags":["orders/items/{id}"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/items/{id}"}},"/V1/orders/{id}":{"get":{"tags":["orders/{id}"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/cancel"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/comments"},"get":{"tags":["orders/{id}/comments"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/comments"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/emails"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/hold"}},"/V1/orders/{id}/statuses":{"get":{"tags":["orders/{id}/statuses"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/statuses"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{id}/unhold"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"orders/{parent_id}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products"},"get":{"tags":["products"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products"}},"/V1/products-render-info":{"get":{"tags":["products-render-info"],"description":"Collect and retrieve the list of product render info This info contains raw prices and formated prices, product name, stock status, store_id, etc","operationId":"catalogProductRenderListV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."},{"name":"storeId","in":"query","type":"integer","required":true},{"name":"currencyCode","in":"query","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-render-search-results-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products-render-info"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/attributes"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/groups"}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["products/attribute-sets/groups/list"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/groups/list"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/groups/{groupId}"}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["products/attribute-sets/sets/list"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/sets/list"}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["products/attribute-sets/{attributeSetId}"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/{attributeSetId}"}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["products/attribute-sets/{attributeSetId}/attributes"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attribute-sets/{attributeSetId}/attributes"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-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"}},"/V1/products/attributes":{"get":{"tags":["products/attributes"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attributes"}},"/V1/products/attributes/types":{"get":{"tags":["products/attributes/types"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attributes/types"}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["products/attributes/{attributeCode}"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attributes/{attributeCode}"}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["products/attributes/{attributeCode}/options"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attributes/{attributeCode}/options"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/attributes/{attributeCode}/options/{optionId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/base-prices"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-base-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/base-prices-information"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/cost"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will return True if deleted."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/cost-delete"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-cost-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/cost-information"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/downloadable-links/samples/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/downloadable-links/{id}"}},"/V1/products/links/types":{"get":{"tags":["products/links/types"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/links/types"}},"/V1/products/links/{type}/attributes":{"get":{"tags":["products/links/{type}/attributes"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/links/{type}/attributes"}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["products/media/types/{attributeSetName}"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/media/types/{attributeSetName}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/options"}},"/V1/products/options/types":{"get":{"tags":["products/options/types"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/options/types"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/options/{optionId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/special-price"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/special-price-delete"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/special-price-information"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/tier-prices"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/tier-prices-delete"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/tier-prices-information"}},"/V1/products/types":{"get":{"tags":["products/types"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/types"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{productSku}/stockItems/{itemId}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}"},"get":{"tags":["products/{sku}"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}"}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["products/{sku}/downloadable-links"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/downloadable-links"}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["products/{sku}/downloadable-links/samples"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-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"},"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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/downloadable-links/samples"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"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}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/downloadable-links/{id}"}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["products/{sku}/group-prices/{customerGroupId}/tiers"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/links"}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["products/{sku}/links/{type}"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","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}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/links/{type}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/links/{type}/{linkedProductSku}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/media"},"get":{"tags":["products/{sku}/media"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/media"}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["products/{sku}/media/{entryId}"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/media/{entryId}"}},"/V1/products/{sku}/options":{"get":{"tags":["products/{sku}/options"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/options"}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["products/{sku}/options/{optionId}"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/options/{optionId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/websites"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"products/{sku}/websites/{websiteId}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/requisition-list-data-requisition-list-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"requisition_lists"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns"},"get":{"tags":["returns"],"description":"Return list of rma data objects based on search criteria","operationId":"rmaRmaManagementV1SearchGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns"}},"/V1/returns/{id}":{"get":{"tags":["returns/{id}"],"description":"Return data object for specified RMA id","operationId":"rmaRmaRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}/comments"},"get":{"tags":["returns/{id}/comments"],"description":"Comments list","operationId":"rmaCommentManagementV1CommentsListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}/comments"}},"/V1/returns/{id}/labels":{"get":{"tags":["returns/{id}/labels"],"description":"Get shipping label int the PDF format","operationId":"rmaTrackManagementV1GetShippingLabelPdfGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}/labels"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}/tracking-numbers"},"get":{"tags":["returns/{id}/tracking-numbers"],"description":"Get track list","operationId":"rmaTrackManagementV1GetTracksGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-track-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}/tracking-numbers"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returns/{id}/tracking-numbers/{trackId}"}},"/V1/returnsAttributeMetadata":{"get":{"tags":["returnsAttributeMetadata"],"description":"Get all attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAllAttributesMetadataGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returnsAttributeMetadata"}},"/V1/returnsAttributeMetadata/custom":{"get":{"tags":["returnsAttributeMetadata/custom"],"description":"Get custom attribute metadata for the given Data object's attribute set","operationId":"rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"dataObjectClassName","in":"query","type":"string","description":"Data object class name","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/framework-metadata-object-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returnsAttributeMetadata/custom"}},"/V1/returnsAttributeMetadata/form/{formCode}":{"get":{"tags":["returnsAttributeMetadata/form/{formCode}"],"description":"Retrieve all attributes filtered by form code","operationId":"rmaRmaAttributesManagementV1GetAttributesGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returnsAttributeMetadata/form/{formCode}"}},"/V1/returnsAttributeMetadata/{attributeCode}":{"get":{"tags":["returnsAttributeMetadata/{attributeCode}"],"description":"Retrieve attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAttributeMetadataGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"returnsAttributeMetadata/{attributeCode}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"reward/mine/use-reward"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"salesRules"}},"/V1/salesRules/search":{"get":{"tags":["salesRules/search"],"description":"Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleRuleRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"salesRules/search"}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRules/{ruleId}"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"salesRules/{ruleId}"}},"/V1/search":{"get":{"tags":["search"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"search"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog"}},"/V1/sharedCatalog/":{"get":{"tags":["sharedCatalog/"],"description":"Return the list of shared catalogs and basic properties for each catalog.","operationId":"sharedCatalogSharedCatalogRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/shared-catalog-data-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}/assignCategories"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}/assignProducts"}},"/V1/sharedCatalog/{id}/categories":{"get":{"tags":["sharedCatalog/{id}/categories"],"description":"Return the list of categories in the selected shared catalog.","operationId":"sharedCatalogCategoryManagementV1GetCategoriesGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"integer"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}/categories"}},"/V1/sharedCatalog/{id}/products":{"get":{"tags":["sharedCatalog/{id}/products"],"description":"Return the list of product SKUs in the selected shared catalog.","operationId":"sharedCatalogProductManagementV1GetProductsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}/products"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}/unassignCategories"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{id}/unassignProducts"}},"/V1/sharedCatalog/{sharedCatalogId}":{"get":{"tags":["sharedCatalog/{sharedCatalogId}"],"description":"Return the following properties for the selected shared catalog: ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.","operationId":"sharedCatalogSharedCatalogRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{sharedCatalogId}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{sharedCatalogId}/assignCompanies"}},"/V1/sharedCatalog/{sharedCatalogId}/companies":{"get":{"tags":["sharedCatalog/{sharedCatalogId}/companies"],"description":"Return the list of company IDs for the companies assigned to the selected catalog.","operationId":"sharedCatalogCompanyManagementV1GetCompaniesGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{sharedCatalogId}/companies"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"sharedCatalog/{sharedCatalogId}/unassignCompanies"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/track"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/track/{id}"}},"/V1/shipment/{id}":{"get":{"tags":["shipment/{id}"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/{id}"}},"/V1/shipment/{id}/comments":{"get":{"tags":["shipment/{id}/comments"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/{id}/comments"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/{id}/emails"}},"/V1/shipment/{id}/label":{"get":{"tags":["shipment/{id}/label"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipment/{id}/label"}},"/V1/shipments":{"get":{"tags":["shipments"],"description":"Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesShipmentRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"shipments"}},"/V1/stockItems/lowStock/":{"get":{"tags":["stockItems/lowStock/"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"stockItems/lowStock/"}},"/V1/stockItems/{productSku}":{"get":{"tags":["stockItems/{productSku}"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"stockItems/{productSku}"}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["stockStatuses/{productSku}"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"stockStatuses/{productSku}"}},"/V1/store/storeConfigs":{"get":{"tags":["store/storeConfigs"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"store/storeConfigs"}},"/V1/store/storeGroups":{"get":{"tags":["store/storeGroups"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"store/storeGroups"}},"/V1/store/storeViews":{"get":{"tags":["store/storeViews"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"store/storeViews"}},"/V1/store/websites":{"get":{"tags":["store/websites"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"store/websites"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxClasses"}},"/V1/taxClasses/search":{"get":{"tags":["taxClasses/search"],"description":"Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxClassRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxClasses/search"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxClasses/{classId}"}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxClasses/{taxClassId}"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxClasses/{taxClassId}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRates"}},"/V1/taxRates/search":{"get":{"tags":["taxRates/search"],"description":"Search TaxRates This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRateRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRates/search"}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxRates/{rateId}"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRates/{rateId}"}},"/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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","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":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRules"}},"/V1/taxRules/search":{"get":{"tags":["taxRules/search"],"description":"Search TaxRules This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRuleRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRules/search"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRules/{ruleId}"},"get":{"tags":["taxRules/{ruleId}"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"taxRules/{ruleId}"}},"/V1/team/":{"get":{"tags":["team/"],"description":"Returns the list of teams for the specified search criteria (team name or description).","operationId":"companyTeamRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-team-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"team/"}},"/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":{"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"team/{companyId}"}},"/V1/team/{teamId}":{"get":{"tags":["team/{teamId}"],"description":"Returns data for a team in the company, by entity id.","operationId":"companyTeamRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"teamId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-team-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"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":{"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"team/{teamId}"}},"/V1/temando/rma/{rmaId}/shipments":{"put":{"tags":["temando/rma/{rmaId}/shipments"],"description":"Assign platform shipment IDs to a core RMA entity.","operationId":"temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPut","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"rmaId","in":"path","type":"integer","required":true},{"name":"temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPutBody","in":"body","schema":{"required":["returnShipmentIds"],"properties":{"returnShipmentIds":{"type":"array","items":{"type":"string"}}},"type":"object","xml":{"name":"request"}}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Number of successfully assigned shipment IDs."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"temando/rma/{rmaId}/shipments"}},"/V1/transactions":{"get":{"tags":["transactions"],"description":"Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesTransactionRepositoryV1GetListGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"transactions"}},"/V1/transactions/{id}":{"get":{"tags":["transactions/{id}"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}},"summary":"transactions/{id}"}},"/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":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"website_id":{"type":"integer"},"store_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","website_id","store_group_id"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"website_id":{"type":"integer"},"root_category_id":{"type":"integer"},"default_store_id":{"type":"integer"},"name":{"type":"string"},"code":{"type":"string","description":"Group code."},"extension_attributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","website_id","root_category_id","default_store_id","name","code"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"default_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","default_group_id"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"website_id":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"base_currency_code":{"type":"string","description":"Base currency code"},"default_display_currency_code":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weight_unit":{"type":"string","description":"The unit of weight"},"base_url":{"type":"string","description":"Base URL for the store"},"base_link_url":{"type":"string","description":"Base link URL for the store"},"base_static_url":{"type":"string","description":"Base static URL for the store"},"base_media_url":{"type":"string","description":"Base media URL for the store"},"secure_base_url":{"type":"string","description":"Secure base URL for the store"},"secure_base_link_url":{"type":"string","description":"Secure base link URL for the store"},"secure_base_static_url":{"type":"string","description":"Secure base static URL for the store"},"secure_base_media_url":{"type":"string","description":"Secure base media URL for the store"},"extension_attributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","website_id","locale","base_currency_code","default_display_currency_code","timezone","weight_unit","base_url","base_link_url","base_static_url","base_media_url","secure_base_url","secure_base_link_url","secure_base_static_url","secure_base_media_url"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"base_currency_code":{"type":"string","description":"The base currency code for the store."},"base_currency_symbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"default_display_currency_code":{"type":"string","description":"The default display currency code for the store."},"default_display_currency_symbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"available_currency_codes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchange_rates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["base_currency_code","base_currency_symbol","default_display_currency_code","default_display_currency_symbol","available_currency_codes","exchange_rates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currency_to":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extension_attributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currency_to","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"two_letter_abbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"three_letter_abbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"full_name_locale":{"type":"string","description":"The country full name (in store locale) for the store."},"full_name_english":{"type":"string","description":"The country full name (in English) for the store."},"available_regions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","two_letter_abbreviation","three_letter_abbreviation","full_name_locale","full_name_english"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extension_attributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"Interface AttributeSetSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["filter_groups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"condition_type":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"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-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontend_input":{"type":"string","description":"HTML for input element."},"input_filter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"store_label":{"type":"string","description":"Label of the store."},"validation_rules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multiline_count":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"data_model":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontend_class":{"type":"string","description":"Class which is used to display the attribute on frontend."},"user_defined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sort_order":{"type":"integer","description":"Attributes sort order."},"frontend_label":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backend_type":{"type":"string","description":"Backend type."},"is_used_in_grid":{"type":"boolean","description":"It is used in customer grid"},"is_visible_in_grid":{"type":"boolean","description":"It is visible in customer grid"},"is_filterable_in_grid":{"type":"boolean","description":"It is filterable in customer grid"},"is_searchable_in_grid":{"type":"boolean","description":"It is searchable in customer grid"},"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["frontend_input","input_filter","store_label","validation_rules","multiline_count","visible","required","data_model","options","frontend_class","user_defined","sort_order","frontend_label","note","system","backend_type","attribute_code"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"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"},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"}},"bundle_product_options":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-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"},"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"},"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"},"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"},"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-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"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"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"Interface AttributeGroupSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-price-update-result-interface":{"type":"object","description":"Interface returned in case of incorrect price passed to efficient price API.","properties":{"message":{"type":"string","description":"Error message, that contains description of error occurred during price update."},"parameters":{"type":"array","description":"Parameters, that could be displayed in error message placeholders.","items":{"type":"string"}},"extension_attributes":{"$ref":"#/definitions/catalog-data-price-update-result-extension-interface"}},"required":["message","parameters"]},"catalog-data-price-update-result-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface"},"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":"","properties":{"id":{"type":"integer"},"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"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"path":{"type":"string"},"available_sort_by":{"type":"array","items":{"type":"string"}},"include_in_menu":{"type":"boolean"},"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-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"product_count":{"type":"integer","description":"Product count"},"children_data":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parent_id","name","is_active","position","level","product_count","children_data"]},"catalog-data-category-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Categories","items":{"$ref":"#/definitions/catalog-data-category-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"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"]},"catalog-data-product-render-search-results-interface":{"type":"object","description":"Dto that holds render information about products","properties":{"items":{"type":"array","description":"List of products rendered information","items":{"$ref":"#/definitions/catalog-data-product-render-interface"}}},"required":["items"]},"catalog-data-product-render-interface":{"type":"object","description":"Represents Data Object which holds enough information to render product This information is put into part as Add To Cart or Add to Compare Data or Price Data","properties":{"add_to_cart_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"add_to_compare_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"price_info":{"$ref":"#/definitions/catalog-data-product-render-price-info-interface"},"images":{"type":"array","description":"Enough information, that needed to render image on front","items":{"$ref":"#/definitions/catalog-data-product-render-image-interface"}},"url":{"type":"string","description":"Product url"},"id":{"type":"integer","description":"Product identifier"},"name":{"type":"string","description":"Product name"},"type":{"type":"string","description":"Product type. Such as bundle, grouped, simple, etc..."},"is_salable":{"type":"string","description":"Information about product saleability (In Stock)"},"store_id":{"type":"integer","description":"Information about current store id or requested store id"},"currency_code":{"type":"string","description":"Current or desired currency code to product"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-extension-interface"}},"required":["add_to_cart_button","add_to_compare_button","price_info","images","url","id","name","type","is_salable","store_id","currency_code","extension_attributes"]},"catalog-data-product-render-button-interface":{"type":"object","description":"Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend","properties":{"post_data":{"type":"string","description":"Post data"},"url":{"type":"string","description":"Url, needed to add product to cart"},"required_options":{"type":"boolean","description":"Flag whether a product has options or not"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-button-extension-interface"}},"required":["post_data","url","required_options"]},"catalog-data-product-render-button-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ButtonInterface"},"catalog-data-product-render-price-info-interface":{"type":"object","description":"Price interface.","properties":{"final_price":{"type":"number","description":"Final price"},"max_price":{"type":"number","description":"Max price of a product"},"max_regular_price":{"type":"number","description":"Max regular price"},"minimal_regular_price":{"type":"number","description":"Minimal regular price"},"special_price":{"type":"number","description":"Special price"},"minimal_price":{"type":"number"},"regular_price":{"type":"number","description":"Regular price"},"formatted_prices":{"$ref":"#/definitions/catalog-data-product-render-formatted-price-info-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-price-info-extension-interface"}},"required":["final_price","max_price","max_regular_price","minimal_regular_price","special_price","minimal_price","regular_price","formatted_prices"]},"catalog-data-product-render-formatted-price-info-interface":{"type":"object","description":"Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html","properties":{"final_price":{"type":"string","description":"Html with final price"},"max_price":{"type":"string","description":"Max price of a product"},"minimal_price":{"type":"string","description":"The minimal price of the product or variation"},"max_regular_price":{"type":"string","description":"Max regular price"},"minimal_regular_price":{"type":"string","description":"Minimal regular price"},"special_price":{"type":"string","description":"Special price"},"regular_price":{"type":"string","description":"Price - is price of product without discounts and special price with taxes and fixed product tax"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-formatted-price-info-extension-interface"}},"required":["final_price","max_price","minimal_price","max_regular_price","minimal_regular_price","special_price","regular_price"]},"catalog-data-product-render-formatted-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\FormattedPriceInfoInterface"},"catalog-data-product-render-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\PriceInfoInterface","properties":{"msrp":{"$ref":"#/definitions/msrp-data-product-render-msrp-price-info-interface"},"tax_adjustments":{"$ref":"#/definitions/catalog-data-product-render-price-info-interface"},"weee_attributes":{"type":"array","items":{"$ref":"#/definitions/weee-data-product-render-weee-adjustment-attribute-interface"}},"weee_adjustment":{"type":"string"}}},"msrp-data-product-render-msrp-price-info-interface":{"type":"object","description":"Price interface.","properties":{"msrp_price":{"type":"string"},"is_applicable":{"type":"string"},"is_shown_price_on_gesture":{"type":"string"},"msrp_message":{"type":"string"},"explanation_message":{"type":"string"},"extension_attributes":{"$ref":"#/definitions/msrp-data-product-render-msrp-price-info-extension-interface"}},"required":["msrp_price","is_applicable","is_shown_price_on_gesture","msrp_message","explanation_message"]},"msrp-data-product-render-msrp-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Msrp\\Api\\Data\\ProductRender\\MsrpPriceInfoInterface"},"weee-data-product-render-weee-adjustment-attribute-interface":{"type":"object","description":"List of all weee attributes, their amounts, etc.., that product has","properties":{"amount":{"type":"string","description":"Weee attribute amount"},"tax_amount":{"type":"string","description":"Tax which is calculated to fixed product tax attribute"},"tax_amount_incl_tax":{"type":"string","description":"Tax amount of weee attribute"},"amount_excl_tax":{"type":"string","description":"Product amount exclude tax"},"attribute_code":{"type":"string","description":"Weee attribute code"},"extension_attributes":{"$ref":"#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface"}},"required":["amount","tax_amount","tax_amount_incl_tax","amount_excl_tax","attribute_code","extension_attributes"]},"weee-data-product-render-weee-adjustment-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Weee\\Api\\Data\\ProductRender\\WeeeAdjustmentAttributeInterface"},"catalog-data-product-render-image-interface":{"type":"object","description":"Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view","properties":{"url":{"type":"string","description":"Image url"},"code":{"type":"string","description":"Image code"},"height":{"type":"number","description":"Image height"},"width":{"type":"number","description":"Image width in px"},"label":{"type":"string","description":"Image label"},"resized_width":{"type":"number","description":"Resize width"},"resized_height":{"type":"number","description":"Resize height"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-image-extension-interface"}},"required":["url","code","height","width","label","resized_width","resized_height"]},"catalog-data-product-render-image-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ImageInterface"},"catalog-data-product-render-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRenderInterface","properties":{"wishlist_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"review_html":{"type":"string"}}},"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"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface","properties":{"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-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":{"gift_registry_id":{"type":"integer"},"checkout_fields":{"type":"array","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"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":{"type":"string"}}},"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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrier_code":{"type":"string","description":"Shipping carrier code."},"method_code":{"type":"string","description":"Shipping method code."},"carrier_title":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"method_title":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"base_amount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"error_message":{"type":"string","description":"Shipping Error message."},"price_excl_tax":{"type":"number","description":"Shipping price excl tax."},"price_incl_tax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrier_code","method_code","amount","base_amount","available","error_message","price_excl_tax","price_incl_tax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grand_total":{"type":"number","description":"Grand total in quote currency"},"base_grand_total":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"base_subtotal":{"type":"number","description":"Subtotal in base currency"},"discount_amount":{"type":"number","description":"Discount amount in quote currency"},"base_discount_amount":{"type":"number","description":"Discount amount in base currency"},"subtotal_with_discount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"base_subtotal_with_discount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shipping_amount":{"type":"number","description":"Shipping amount in quote currency"},"base_shipping_amount":{"type":"number","description":"Shipping amount in base currency"},"shipping_discount_amount":{"type":"number","description":"Shipping discount amount in quote currency"},"base_shipping_discount_amount":{"type":"number","description":"Shipping discount amount in base currency"},"tax_amount":{"type":"number","description":"Tax amount in quote currency"},"base_tax_amount":{"type":"number","description":"Tax amount in base currency"},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount in quote currency"},"base_shipping_tax_amount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in quote currency"},"base_subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in base currency"},"shipping_incl_tax":{"type":"number","description":"Shipping including tax in quote currency"},"base_shipping_incl_tax":{"type":"number","description":"Shipping including tax in base currency"},"base_currency_code":{"type":"string","description":"Base currency code"},"quote_currency_code":{"type":"string","description":"Quote currency code"},"coupon_code":{"type":"string","description":"Applied coupon code"},"items_qty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"total_segments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weee_tax_applied_amount","total_segments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"item_id":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"base_price":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"row_total":{"type":"number","description":"Row total in quote currency."},"base_row_total":{"type":"number","description":"Row total in base currency."},"row_total_with_discount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"tax_amount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"base_tax_amount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"tax_percent":{"type":"number","description":"Tax percent. Otherwise, null."},"discount_amount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"base_discount_amount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discount_percent":{"type":"number","description":"Discount percent. Otherwise, null."},"price_incl_tax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"base_price_incl_tax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"row_total_incl_tax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"base_row_total_incl_tax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weee_tax_applied":{"type":"string","description":"Item weee tax applied in quote currency."},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["item_id","price","base_price","qty","row_total","base_row_total","options","weee_tax_applied_amount","weee_tax_applied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface","properties":{"negotiable_quote_item_totals":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface"}}},"negotiable-quote-data-negotiable-quote-item-totals-interface":{"type":"object","description":"Extension attribute for quote item totals model.","properties":{"cost":{"type":"number","description":"Cost for quote item."},"catalog_price":{"type":"number","description":"Catalog price for quote item."},"base_catalog_price":{"type":"number","description":"Catalog price for quote item in base currency."},"catalog_price_incl_tax":{"type":"number","description":"Catalog price with included tax for quote item."},"base_catalog_price_incl_tax":{"type":"number","description":"Catalog price with included tax for quote item in base currency."},"cart_price":{"type":"number","description":"Cart price for quote item."},"base_cart_price":{"type":"number","description":"Cart price for quote item in base currency."},"cart_tax":{"type":"number","description":"Tax from catalog price for quote item."},"base_cart_tax":{"type":"number","description":"Tax from catalog price for quote item in base currency."},"cart_price_incl_tax":{"type":"number","description":"Cart price with included tax for quote item."},"base_cart_price_incl_tax":{"type":"number","description":"Cart price with included tax for quote item in base currency."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface"}},"required":["cost","catalog_price","base_catalog_price","catalog_price_incl_tax","base_catalog_price_incl_tax","cart_price","base_cart_price","cart_tax","base_cart_tax","cart_price_incl_tax","base_cart_price_incl_tax"]},"negotiable-quote-data-negotiable-quote-item-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteItemTotalsInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extension_attributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"tax_grandtotal_details":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}},"gift_cards":{"type":"string"},"gw_order_id":{"type":"string"},"gw_item_ids":{"type":"array","items":{"type":"string"}},"gw_allow_gift_receipt":{"type":"string"},"gw_add_card":{"type":"string"},"gw_price":{"type":"string"},"gw_base_price":{"type":"string"},"gw_items_price":{"type":"string"},"gw_items_base_price":{"type":"string"},"gw_card_price":{"type":"string"},"gw_card_base_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_price_incl_tax":{"type":"string"},"gw_base_price_incl_tax":{"type":"string"},"gw_card_price_incl_tax":{"type":"string"},"gw_card_base_price_incl_tax":{"type":"string"},"gw_items_price_incl_tax":{"type":"string"},"gw_items_base_price_incl_tax":{"type":"string"},"vertex_tax_calculation_messages":{"type":"array","items":{"type":"string"}}}},"tax-data-grand-total-details-interface":{"type":"object","description":"Interface GrandTotalDetailsInterface","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"group_id":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","group_id"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"Interface GrandTotalRatesInterface","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface","properties":{"coupon_label":{"type":"string"},"base_customer_balance_amount":{"type":"number"},"customer_balance_amount":{"type":"number"},"negotiable_quote_totals":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-totals-interface"},"reward_points_balance":{"type":"number"},"reward_currency_amount":{"type":"number"},"base_reward_currency_amount":{"type":"number"}}},"negotiable-quote-data-negotiable-quote-totals-interface":{"type":"object","description":"Extension attribute for quote totals model.","properties":{"items_count":{"type":"integer","description":"The number of different items or products in the cart."},"quote_status":{"type":"string","description":"Negotiable quote status."},"created_at":{"type":"string","description":"The cart creation date and time."},"updated_at":{"type":"string","description":"The cart last update date and time."},"customer_group":{"type":"integer","description":"Customer group id."},"base_to_quote_rate":{"type":"number","description":"Base currency to quote currency rate."},"cost_total":{"type":"number","description":"Total cost for quote."},"base_cost_total":{"type":"number","description":"Total cost for quote in base currency."},"original_total":{"type":"number","description":"Original quote total."},"base_original_total":{"type":"number","description":"Original quote total in base currency."},"original_tax":{"type":"number","description":"Original tax amount for quote."},"base_original_tax":{"type":"number","description":"Original tax amount for quote in base currency."},"original_price_incl_tax":{"type":"number","description":"Original price with included tax for quote."},"base_original_price_incl_tax":{"type":"number","description":"Original price with included tax for quote in base currency."},"negotiated_price_type":{"type":"integer","description":"Negotiable quote type."},"negotiated_price_value":{"type":"number","description":"Negotiable price value for quote."}},"required":["items_count","quote_status","created_at","updated_at","customer_group","base_to_quote_rate","cost_total","base_cost_total","original_total","base_original_total","original_tax","base_original_tax","original_price_incl_tax","base_original_price_incl_tax","negotiated_price_type","negotiated_price_value"]},"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"}}},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extension_attributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"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":"string","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"},"framework-search-search-result-interface":{"type":"object","description":"Interface SearchResultInterface","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"search_criteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","aggregations","search_criteria","total_count"]},"framework-search-document-interface":{"type":"object","description":"Interface \\Magento\\Framework\\Api\\Search\\DocumentInterface","properties":{"id":{"type":"integer"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucket_names":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucket_names"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"Interface \\Magento\\Framework\\Api\\Search\\AggregationValueInterface","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"Interface SearchCriteriaInterface","properties":{"request_name":{"type":"string"},"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["request_name","filter_groups"]},"catalog-inventory-data-stock-item-collection-interface":{"type":"object","description":"Interface StockItemCollectionInterface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"search_criteria":{"$ref":"#/definitions/catalog-inventory-stock-item-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-inventory-stock-item-criteria-interface":{"type":"object","description":"Interface StockItemCriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"product_id":{"type":"integer"},"stock_id":{"type":"integer"},"qty":{"type":"integer"},"stock_status":{"type":"integer"},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["product_id","stock_id","qty","stock_status","stock_item"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"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","properties":{"checkout_fields":{"type":"array","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"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":{"type":"string"}}},"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","properties":{"ext_order_id":{"type":"string"},"shipping_experience":{"$ref":"#/definitions/temando-shipping-data-order-shipping-experience-interface"},"collection_point":{"$ref":"#/definitions/temando-shipping-data-collection-point-order-collection-point-interface"}}},"temando-shipping-data-order-shipping-experience-interface":{"type":"object","description":"Temando Shipping Experience Interface Local representation of a shipping rate in checkout. A set of shipping experiences is the result of creating an order at the Temando platform. (!) Needs to reside in Api namespace because selected shipping experience is exposed to public as a ShippingInterface extension attribute.","properties":{"label":{"type":"string"},"code":{"type":"string"},"cost":{"type":"number"}},"required":["label","code","cost"]},"temando-shipping-data-collection-point-order-collection-point-interface":{"type":"object","description":"Temando Order Collection Point Interface – Order Details/Fulfillment","properties":{"recipient_address_id":{"type":"integer"},"collection_point_id":{"type":"string"},"name":{"type":"string"},"country":{"type":"string"},"region":{"type":"string"},"postcode":{"type":"string"},"city":{"type":"string"},"street":{"type":"array","items":{"type":"string"}}},"required":["recipient_address_id","collection_point_id","name","country","region","postcode","city","street"]},"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"]},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-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-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-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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":{"ext_shipment_id":{"type":"string"},"ext_return_shipment_id":{"type":"string"},"ext_location_id":{"type":"string"},"ext_tracking_url":{"type":"string"},"ext_tracking_reference":{"type":"string"}}},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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":{"shipping_label":{"type":"string"},"ext_shipment_id":{"type":"string"},"ext_return_shipment_id":{"type":"string"},"ext_location_id":{"type":"string"},"ext_tracking_url":{"type":"string"},"ext_tracking_reference":{"type":"string"}}},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transaction_id":{"type":"integer","description":"Transaction ID."},"parent_id":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"order_id":{"type":"integer","description":"Order ID."},"payment_id":{"type":"integer","description":"Payment ID."},"txn_id":{"type":"string","description":"Transaction business ID."},"parent_txn_id":{"type":"string","description":"Parent transaction business ID."},"txn_type":{"type":"string","description":"Transaction type."},"is_closed":{"type":"integer","description":"Is-closed flag value."},"additional_information":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"created_at":{"type":"string","description":"Created-at timestamp."},"child_transactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transaction_id","order_id","payment_id","txn_id","parent_txn_id","txn_type","is_closed","created_at","child_transactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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-payment-details-interface":{"type":"object","description":"Interface PaymentDetailsInterface","properties":{"payment_methods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extension_attributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["payment_methods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"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-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failed_items":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missing_items":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failed_items","missing_items"]},"checkout-agreements-data-agreement-interface":{"type":"object","description":"Interface AgreementInterface","properties":{"agreement_id":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"content_height":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkbox_text":{"type":"string","description":"Agreement checkbox text."},"is_active":{"type":"boolean","description":"Agreement status."},"is_html":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extension_attributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreement_id","name","content","checkbox_text","is_active","is_html","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-data-company-search-results-interface":{"type":"object","description":"Interface for company search results","properties":{"items":{"type":"array","description":"Companies list","items":{"$ref":"#/definitions/company-data-company-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-search-results-interface":{"type":"object","description":"Interface for company team search results","properties":{"items":{"type":"array","description":"Teams list","items":{"$ref":"#/definitions/company-data-team-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-hierarchy-interface":{"type":"object","description":"Company hierarchy DTO interface for WebAPI.","properties":{"structure_id":{"type":"integer","description":"Structure ID."},"entity_id":{"type":"integer","description":"Entity ID."},"entity_type":{"type":"string","description":"Entity type."},"structure_parent_id":{"type":"integer","description":"Structure parent ID."},"extension_attributes":{"$ref":"#/definitions/company-data-hierarchy-extension-interface"}}},"company-data-hierarchy-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\HierarchyInterface"},"company-data-role-search-results-interface":{"type":"object","description":"Interface for role search results.","properties":{"items":{"type":"array","description":"Roles list.","items":{"$ref":"#/definitions/company-data-role-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"analytics-data-link-interface":{"type":"object","description":"Interface LinkInterface Represents link with collected data and initialized vector for decryption.","properties":{"url":{"type":"string"},"initialization_vector":{"type":"string"}},"required":["url","initialization_vector"]},"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"},"negotiable-quote-data-comment-interface":{"type":"object","description":"Interface CommentInterface","properties":{"entity_id":{"type":"integer","description":"Comment ID."},"parent_id":{"type":"integer","description":"Negotiable quote ID, that this comment belongs to."},"creator_type":{"type":"integer","description":"The comment creator type."},"is_decline":{"type":"integer","description":"Is quote was declined by seller."},"is_draft":{"type":"integer","description":"Is quote draft flag."},"creator_id":{"type":"integer","description":"Comment creator ID."},"comment":{"type":"string","description":"Comment."},"created_at":{"type":"string","description":"Comment created at."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-comment-extension-interface"},"attachments":{"type":"array","description":"Existing attachments.","items":{"$ref":"#/definitions/negotiable-quote-data-comment-attachment-interface"}}},"required":["entity_id","parent_id","creator_type","is_decline","is_draft","creator_id","comment","created_at","attachments"]},"negotiable-quote-data-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentInterface"},"negotiable-quote-data-comment-attachment-interface":{"type":"object","description":"Interface for quote comment attachment.","properties":{"attachment_id":{"type":"integer","description":"Attachment ID."},"comment_id":{"type":"integer","description":"Comment ID."},"file_name":{"type":"string","description":"File name."},"file_path":{"type":"string","description":"File path."},"file_type":{"type":"string","description":"File type."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-comment-attachment-extension-interface"}},"required":["attachment_id","comment_id","file_name","file_path","file_type"]},"negotiable-quote-data-comment-attachment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentAttachmentInterface"},"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","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"},"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 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"]},"shared-catalog-data-search-results-interface":{"type":"object","description":"Interface for Shared Catalog search results.","properties":{"items":{"type":"array","description":"Shared Catalog list.","items":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"gift-wrapping-data-wrapping-search-results-interface":{"type":"object","description":"Interface WrappingSearchResultsInterface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-track-search-result-interface":{"type":"object","description":"Interface TrackSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-track-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"rma-data-comment-search-result-interface":{"type":"object","description":"Interface CommentSearchResultInterface","properties":{"items":{"type":"array","description":"Rma Status History list","items":{"$ref":"#/definitions/rma-data-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"rma-data-rma-search-result-interface":{"type":"object","description":"Interface RmaSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-rma-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"framework-metadata-object-interface":{"type":"object","description":"Provides metadata about an attribute.","properties":{"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["attribute_code"]},"company-credit-data-credit-limit-search-results-interface":{"type":"object","description":"Interface for Credit Limit search results.","properties":{"items":{"type":"array","description":"Credit Limit list.","items":{"$ref":"#/definitions/company-credit-data-credit-data-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-credit-data-interface":{"type":"object","description":"Credit Data 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."}},"required":["exceed_limit"]},"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"]},"company-credit-data-history-search-results-interface":{"type":"object","description":"Interface for History search results.","properties":{"items":{"type":"array","description":"History list.","items":{"$ref":"#/definitions/company-credit-data-history-data-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-history-data-interface":{"type":"object","description":"History data transfer object interface.","properties":{"id":{"type":"integer","description":"ID."},"company_credit_id":{"type":"integer","description":"Company credit id."},"user_id":{"type":"integer","description":"User Id."},"user_type":{"type":"integer","description":"User type: integration, admin, customer."},"currency_credit":{"type":"string","description":"Currency code of credit."},"currency_operation":{"type":"string","description":"Currency code of operation."},"rate":{"type":"number","description":"Currency rate between credit and operation currencies."},"rate_credit":{"type":"number","description":"Rate between credit and base currencies."},"amount":{"type":"number","description":"Amount."},"balance":{"type":"number","description":"Outstanding balance."},"credit_limit":{"type":"number","description":"Credit limit."},"available_limit":{"type":"number","description":"Available limit."},"type":{"type":"integer","description":"Type of operation."},"datetime":{"type":"string","description":"Operation datetime."},"purchase_order":{"type":"string","description":"Purchase Order number."},"comment":{"type":"string","description":"Comment."}},"required":["rate","amount","balance","credit_limit"]},"asynchronous-operations-data-detailed-bulk-operations-status-interface":{"type":"object","description":"Interface BulkStatusInterface Bulk summary data with list of operations items full data.","properties":{"operations_list":{"type":"array","description":"Operations list.","items":{"$ref":"#/definitions/asynchronous-operations-data-detailed-operation-status-interface"}},"extension_attributes":{"$ref":"#/definitions/asynchronous-operations-data-bulk-summary-extension-interface"},"bulk_id":{"type":"string","description":"Bulk uuid"},"description":{"type":"string","description":"Bulk description"},"start_time":{"type":"string","description":"Bulk scheduled time"},"user_id":{"type":"integer","description":"User id"},"operation_count":{"type":"integer","description":"Total number of operations scheduled in scope of this bulk"}},"required":["operations_list","bulk_id","description","start_time","user_id","operation_count"]},"asynchronous-operations-data-detailed-operation-status-interface":{"type":"object","description":"","properties":{"result_serialized_data":{"type":"string","description":"Serialized Data"},"extension_attributes":{"$ref":"#/definitions/asynchronous-operations-data-operation-extension-interface"},"id":{"type":"integer","description":"Id"},"bulk_uuid":{"type":"string","description":"Bulk uuid"},"topic_name":{"type":"string","description":"Queue Topic"},"serialized_data":{"type":"string","description":"Data"},"status":{"type":"integer","description":"Operation status"},"result_message":{"type":"string","description":"Result message"},"error_code":{"type":"integer","description":"Error code"}},"required":["result_serialized_data","id","bulk_uuid","topic_name","serialized_data","status","result_message","error_code"]},"asynchronous-operations-data-operation-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\OperationInterface"},"asynchronous-operations-data-bulk-summary-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\BulkSummaryInterface"},"asynchronous-operations-data-bulk-operations-status-interface":{"type":"object","description":"Interface BulkStatusInterface Bulk summary data with list of operations items summary data.","properties":{"operations_list":{"type":"array","description":"List of operation with statuses (short data).","items":{"$ref":"#/definitions/asynchronous-operations-data-summary-operation-status-interface"}},"extension_attributes":{"$ref":"#/definitions/asynchronous-operations-data-bulk-summary-extension-interface"},"bulk_id":{"type":"string","description":"Bulk uuid"},"description":{"type":"string","description":"Bulk description"},"start_time":{"type":"string","description":"Bulk scheduled time"},"user_id":{"type":"integer","description":"User id"},"operation_count":{"type":"integer","description":"Total number of operations scheduled in scope of this bulk"}},"required":["operations_list","bulk_id","description","start_time","user_id","operation_count"]},"asynchronous-operations-data-summary-operation-status-interface":{"type":"object","description":"Getter Class OperationsStatusInterface Instead of OperationInterface this class don't provide all operation data and not responsive to set any data, just to get operation data without serialized_data and result_serialized_data","properties":{"id":{"type":"integer","description":"Id"},"status":{"type":"integer","description":"Operation status"},"result_message":{"type":"string","description":"Result message"},"error_code":{"type":"integer","description":"Error code"}},"required":["id","status","result_message","error_code"]},"temando-shipping-data-collection-point-search-request-interface":{"type":"object","description":"Temando Collection Point Search Request Interface","properties":{"shipping_address_id":{"type":"integer"},"country_id":{"type":"string"},"postcode":{"type":"string"},"pending":{"type":"boolean"}},"required":["shipping_address_id","country_id","postcode","pending"]},"temando-shipping-data-collection-point-quote-collection-point-interface":{"type":"object","description":"Temando Quote Collection Point Interface – Checkout/Quoting","properties":{"entity_id":{"type":"integer"},"collection_point_id":{"type":"string"},"recipient_address_id":{"type":"integer"},"name":{"type":"string"},"country":{"type":"string"},"region":{"type":"string"},"postcode":{"type":"string"},"city":{"type":"string"},"street":{"type":"array","items":{"type":"string"}},"opening_hours":{"type":"array","items":{"type":"string"}},"shipping_experiences":{"type":"array","items":{"type":"string"}},"selected":{"type":"boolean"}},"required":["entity_id","collection_point_id","recipient_address_id","name","country","region","postcode","city","street","opening_hours","shipping_experiences","selected"]}},"x-tagGroups":[{"name":"addresses","tags":["addresses/{addressId}"]},{"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":"analytics","tags":["analytics/link"]},{"name":"attributeMetadata","tags":["attributeMetadata/customer","attributeMetadata/customer/attribute/{attributeCode}","attributeMetadata/customer/custom","attributeMetadata/customer/form/{formCode}","attributeMetadata/customerAddress","attributeMetadata/customerAddress/attribute/{attributeCode}","attributeMetadata/customerAddress/custom","attributeMetadata/customerAddress/form/{formCode}"]},{"name":"bulk","tags":["bulk/{bulkUuid}/detailed-status","bulk/{bulkUuid}/operation-status/{status}","bulk/{bulkUuid}/status"]},{"name":"bundle products","tags":["bundle-products/options/add","bundle-products/options/types","bundle-products/options/{optionId}","bundle-products/{productSku}/children","bundle-products/{sku}/links/{id}","bundle-products/{sku}/links/{optionId}","bundle-products/{sku}/options/all","bundle-products/{sku}/options/{optionId}","bundle-products/{sku}/options/{optionId}/children/{childSku}"]},{"name":"carts","tags":["carts/","carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}","carts/guest-carts/{cartId}/giftCards","carts/guest-carts/{cartId}/giftCards/{giftCardCode}","carts/licence","carts/mine","carts/mine/balance/apply","carts/mine/balance/unapply","carts/mine/billing-address","carts/mine/checkGiftCard/{giftCardCode}","carts/mine/checkout-fields","carts/mine/collect-totals","carts/mine/collection-point/search-request","carts/mine/collection-point/search-result","carts/mine/collection-point/select","carts/mine/coupons","carts/mine/coupons/{couponCode}","carts/mine/delivery-option","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/payment-methods","carts/mine/selected-payment-method","carts/mine/set-payment-information","carts/mine/shipping-information","carts/mine/shipping-methods","carts/mine/totals","carts/mine/totals-information","carts/search","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","carts/{cartId}/items/{itemId}","carts/{cartId}/order","carts/{cartId}/payment-methods","carts/{cartId}/selected-payment-method","carts/{cartId}/shipping-information","carts/{cartId}/shipping-methods","carts/{cartId}/totals","carts/{cartId}/totals-information","carts/{quoteId}/giftCards","carts/{quoteId}/items"]},{"name":"categories","tags":["categories","categories/attributes","categories/attributes/{attributeCode}","categories/attributes/{attributeCode}/options","categories/list","categories/{categoryId}","categories/{categoryId}/move","categories/{categoryId}/products","categories/{categoryId}/products/{sku}","categories/{id}"]},{"name":"cmsBlock","tags":["cmsBlock","cmsBlock/search","cmsBlock/{blockId}","cmsBlock/{id}"]},{"name":"cmsPage","tags":["cmsPage","cmsPage/search","cmsPage/{id}","cmsPage/{pageId}"]},{"name":"company","tags":["company/","company/assignRoles","company/role/","company/role/{id}","company/role/{roleId}","company/role/{roleId}/users","company/{companyId}"]},{"name":"companyCredits","tags":["companyCredits/","companyCredits/company/{companyId}","companyCredits/history","companyCredits/history/{historyId}","companyCredits/{creditId}","companyCredits/{creditId}/decreaseBalance","companyCredits/{creditId}/increaseBalance","companyCredits/{id}"]},{"name":"configurable products","tags":["configurable-products/variation","configurable-products/{sku}/child","configurable-products/{sku}/children","configurable-products/{sku}/children/{childSku}","configurable-products/{sku}/options","configurable-products/{sku}/options/all","configurable-products/{sku}/options/{id}"]},{"name":"coupons","tags":["coupons","coupons/deleteByCodes","coupons/deleteByIds","coupons/generate","coupons/search","coupons/{couponId}"]},{"name":"creditmemo","tags":["creditmemo","creditmemo/refund","creditmemo/{id}","creditmemo/{id}/comments","creditmemo/{id}/emails"]},{"name":"creditmemos","tags":["creditmemos"]},{"name":"customerGroups","tags":["customerGroups","customerGroups/default","customerGroups/default/{id}","customerGroups/default/{storeId}","customerGroups/search","customerGroups/{id}","customerGroups/{id}/permissions"]},{"name":"customers","tags":["customers","customers/addresses/{addressId}","customers/confirm","customers/isEmailAvailable","customers/me","customers/me/activate","customers/me/billingAddress","customers/me/password","customers/me/shippingAddress","customers/password","customers/resetPassword","customers/search","customers/validate","customers/{customerId}","customers/{customerId}/billingAddress","customers/{customerId}/carts","customers/{customerId}/confirm","customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}","customers/{customerId}/permissions/readonly","customers/{customerId}/shippingAddress","customers/{email}/activate"]},{"name":"directory","tags":["directory/countries","directory/countries/{countryId}","directory/currency"]},{"name":"eav","tags":["eav/attribute-sets","eav/attribute-sets/list","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}/checkout-fields","guest-carts/{cartId}/collect-totals","guest-carts/{cartId}/collection-point/search-request","guest-carts/{cartId}/collection-point/search-result","guest-carts/{cartId}/collection-point/select","guest-carts/{cartId}/coupons","guest-carts/{cartId}/coupons/{couponCode}","guest-carts/{cartId}/delivery-option","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}/payment-methods","guest-carts/{cartId}/selected-payment-method","guest-carts/{cartId}/set-payment-information","guest-carts/{cartId}/shipping-information","guest-carts/{cartId}/shipping-methods","guest-carts/{cartId}/totals","guest-carts/{cartId}/totals-information"]},{"name":"guest giftregistry","tags":["guest-giftregistry/{cartId}/estimate-shipping-methods"]},{"name":"hierarchy","tags":["hierarchy/move/{id}","hierarchy/{id}"]},{"name":"integration","tags":["integration/admin/token","integration/customer/token"]},{"name":"invoice","tags":["invoice/{invoiceId}/refund"]},{"name":"invoices","tags":["invoices","invoices/","invoices/comments","invoices/{id}","invoices/{id}/capture","invoices/{id}/comments","invoices/{id}/emails","invoices/{id}/void"]},{"name":"modules","tags":["modules"]},{"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","negotiable-carts/{cartId}/totals"]},{"name":"negotiableQuote","tags":["negotiableQuote/attachmentContent","negotiableQuote/decline","negotiableQuote/pricesUpdated","negotiableQuote/request","negotiableQuote/submitToCustomer","negotiableQuote/{quoteId}","negotiableQuote/{quoteId}/comments","negotiableQuote/{quoteId}/shippingMethod"]},{"name":"order","tags":["order/{orderId}/invoice","order/{orderId}/refund","order/{orderId}/ship"]},{"name":"orders","tags":["orders","orders/","orders/create","orders/items","orders/items/{id}","orders/{id}","orders/{id}/cancel","orders/{id}/comments","orders/{id}/emails","orders/{id}/hold","orders/{id}/statuses","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/list","products/attribute-sets/groups/{groupId}","products/attribute-sets/sets/list","products/attribute-sets/{attributeSetId}","products/attribute-sets/{attributeSetId}/attributes","products/attribute-sets/{attributeSetId}/attributes/{attributeCode}","products/attribute-sets/{attributeSetId}/groups","products/attributes","products/attributes/types","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/links/types","products/links/{type}/attributes","products/media/types/{attributeSetName}","products/options","products/options/types","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/types","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","products/{sku}/group-prices/{customerGroupId}/tiers/{qty}","products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}","products/{sku}/links","products/{sku}/links/{type}","products/{sku}/links/{type}/{linkedProductSku}","products/{sku}/media","products/{sku}/media/{entryId}","products/{sku}/options","products/{sku}/options/{optionId}","products/{sku}/websites","products/{sku}/websites/{websiteId}"]},{"name":"products render info","tags":["products-render-info"]},{"name":"requisition_lists","tags":["requisition_lists"]},{"name":"returns","tags":["returns","returns/{id}","returns/{id}/comments","returns/{id}/labels","returns/{id}/tracking-numbers","returns/{id}/tracking-numbers/{trackId}"]},{"name":"returnsAttributeMetadata","tags":["returnsAttributeMetadata","returnsAttributeMetadata/custom","returnsAttributeMetadata/form/{formCode}","returnsAttributeMetadata/{attributeCode}"]},{"name":"reward","tags":["reward/mine/use-reward"]},{"name":"salesRules","tags":["salesRules","salesRules/search","salesRules/{ruleId}"]},{"name":"search","tags":["search"]},{"name":"sharedCatalog","tags":["sharedCatalog","sharedCatalog/","sharedCatalog/{id}","sharedCatalog/{id}/assignCategories","sharedCatalog/{id}/assignProducts","sharedCatalog/{id}/categories","sharedCatalog/{id}/products","sharedCatalog/{id}/unassignCategories","sharedCatalog/{id}/unassignProducts","sharedCatalog/{sharedCatalogId}","sharedCatalog/{sharedCatalogId}/assignCompanies","sharedCatalog/{sharedCatalogId}/companies","sharedCatalog/{sharedCatalogId}/unassignCompanies"]},{"name":"shipment","tags":["shipment/","shipment/track","shipment/track/{id}","shipment/{id}","shipment/{id}/comments","shipment/{id}/emails","shipment/{id}/label"]},{"name":"shipments","tags":["shipments"]},{"name":"stockItems","tags":["stockItems/lowStock/","stockItems/{productSku}"]},{"name":"stockStatuses","tags":["stockStatuses/{productSku}"]},{"name":"store","tags":["store/storeConfigs","store/storeGroups","store/storeViews","store/websites"]},{"name":"taxClasses","tags":["taxClasses","taxClasses/search","taxClasses/{classId}","taxClasses/{taxClassId}"]},{"name":"taxRates","tags":["taxRates","taxRates/search","taxRates/{rateId}"]},{"name":"taxRules","tags":["taxRules","taxRules/search","taxRules/{ruleId}"]},{"name":"team","tags":["team/","team/{companyId}","team/{teamId}"]},{"name":"temando","tags":["temando/rma/{rmaId}/shipments"]},{"name":"transactions","tags":["transactions","transactions/{id}"]},{"name":"worldpay guest carts","tags":["worldpay-guest-carts/{cartId}/payment-information"]}]} diff --git a/src/swagger/css/print.css b/src/swagger/css/print.css deleted file mode 100755 index a5187a7c566..00000000000 --- a/src/swagger/css/print.css +++ /dev/null @@ -1,1175 +0,0 @@ -/* Original style from softwaremaniacs.org (c) Ivan Sagalaev */ -.swagger-section pre code { - display: block; - padding: 0.5em; - background: #F0F0F0; -} -.swagger-section pre code, -.swagger-section pre .subst, -.swagger-section pre .tag .title, -.swagger-section pre .lisp .title, -.swagger-section pre .clojure .built_in, -.swagger-section pre .nginx .title { - color: black; -} -.swagger-section pre .string, -.swagger-section pre .title, -.swagger-section pre .constant, -.swagger-section pre .parent, -.swagger-section pre .tag .value, -.swagger-section pre .rules .value, -.swagger-section pre .rules .value .number, -.swagger-section pre .preprocessor, -.swagger-section pre .ruby .symbol, -.swagger-section pre .ruby .symbol .string, -.swagger-section pre .aggregate, -.swagger-section pre .template_tag, -.swagger-section pre .django .variable, -.swagger-section pre .smalltalk .class, -.swagger-section pre .addition, -.swagger-section pre .flow, -.swagger-section pre .stream, -.swagger-section pre .bash .variable, -.swagger-section pre .apache .tag, -.swagger-section pre .apache .cbracket, -.swagger-section pre .tex .command, -.swagger-section pre .tex .special, -.swagger-section pre .erlang_repl .function_or_atom, -.swagger-section pre .markdown .header { - color: #800; -} -.swagger-section pre .comment, -.swagger-section pre .annotation, -.swagger-section pre .template_comment, -.swagger-section pre .diff .header, -.swagger-section pre .chunk, -.swagger-section pre .markdown .blockquote { - color: #888; -} -.swagger-section pre .number, -.swagger-section pre .date, -.swagger-section pre .regexp, -.swagger-section pre .literal, -.swagger-section pre .smalltalk .symbol, -.swagger-section pre .smalltalk .char, -.swagger-section pre .go .constant, -.swagger-section pre .change, -.swagger-section pre .markdown .bullet, -.swagger-section pre .markdown .link_url { - color: #080; -} -.swagger-section pre .label, -.swagger-section pre .javadoc, -.swagger-section pre .ruby .string, -.swagger-section pre .decorator, -.swagger-section pre .filter .argument, -.swagger-section pre .localvars, -.swagger-section pre .array, -.swagger-section pre .attr_selector, -.swagger-section pre .important, -.swagger-section pre .pseudo, -.swagger-section pre .pi, -.swagger-section pre .doctype, -.swagger-section pre .deletion, -.swagger-section pre .envvar, -.swagger-section pre .shebang, -.swagger-section pre .apache .sqbracket, -.swagger-section pre .nginx .built_in, -.swagger-section pre .tex .formula, -.swagger-section pre .erlang_repl .reserved, -.swagger-section pre .prompt, -.swagger-section pre .markdown .link_label, -.swagger-section pre .vhdl .attribute, -.swagger-section pre .clojure .attribute, -.swagger-section pre .coffeescript .property { - color: #88F; -} -.swagger-section pre .keyword, -.swagger-section pre .id, -.swagger-section pre .phpdoc, -.swagger-section pre .title, -.swagger-section pre .built_in, -.swagger-section pre .aggregate, -.swagger-section pre .css .tag, -.swagger-section pre .javadoctag, -.swagger-section pre .phpdoc, -.swagger-section pre .yardoctag, -.swagger-section pre .smalltalk .class, -.swagger-section pre .winutils, -.swagger-section pre .bash .variable, -.swagger-section pre .apache .tag, -.swagger-section pre .go .typename, -.swagger-section pre .tex .command, -.swagger-section pre .markdown .strong, -.swagger-section pre .request, -.swagger-section pre .status { - font-weight: bold; -} -.swagger-section pre .markdown .emphasis { - font-style: italic; -} -.swagger-section pre .nginx .built_in { - font-weight: normal; -} -.swagger-section pre .coffeescript .javascript, -.swagger-section pre .javascript .xml, -.swagger-section pre .tex .formula, -.swagger-section pre .xml .javascript, -.swagger-section pre .xml .vbscript, -.swagger-section pre .xml .css, -.swagger-section pre .xml .cdata { - opacity: 0.5; -} -.swagger-section .swagger-ui-wrap { - line-height: 1; - font-family: "Droid Sans", sans-serif; - max-width: 960px; - margin-left: auto; - margin-right: auto; -} -.swagger-section .swagger-ui-wrap b, -.swagger-section .swagger-ui-wrap strong { - font-family: "Droid Sans", sans-serif; - font-weight: bold; -} -.swagger-section .swagger-ui-wrap q, -.swagger-section .swagger-ui-wrap blockquote { - quotes: none; -} -.swagger-section .swagger-ui-wrap p { - line-height: 1.4em; - padding: 0 0 10px; - color: #333333; -} -.swagger-section .swagger-ui-wrap q:before, -.swagger-section .swagger-ui-wrap q:after, -.swagger-section .swagger-ui-wrap blockquote:before, -.swagger-section .swagger-ui-wrap blockquote:after { - content: none; -} -.swagger-section .swagger-ui-wrap .heading_with_menu h1, -.swagger-section .swagger-ui-wrap .heading_with_menu h2, -.swagger-section .swagger-ui-wrap .heading_with_menu h3, -.swagger-section .swagger-ui-wrap .heading_with_menu h4, -.swagger-section .swagger-ui-wrap .heading_with_menu h5, -.swagger-section .swagger-ui-wrap .heading_with_menu h6 { - display: block; - clear: none; - float: left; - -moz-box-sizing: border-box; - -webkit-box-sizing: border-box; - -ms-box-sizing: border-box; - box-sizing: border-box; - width: 60%; -} -.swagger-section .swagger-ui-wrap table { - border-collapse: collapse; - border-spacing: 0; -} -.swagger-section .swagger-ui-wrap table thead tr th { - padding: 5px; - font-size: 0.9em; - color: #666666; - border-bottom: 1px solid #999999; -} -.swagger-section .swagger-ui-wrap table tbody tr:last-child td { - border-bottom: none; -} -.swagger-section .swagger-ui-wrap table tbody tr.offset { - background-color: #f0f0f0; -} -.swagger-section .swagger-ui-wrap table tbody tr td { - padding: 6px; - font-size: 0.9em; - border-bottom: 1px solid #cccccc; - vertical-align: top; - line-height: 1.3em; -} -.swagger-section .swagger-ui-wrap ol { - margin: 0px 0 10px; - padding: 0 0 0 18px; - list-style-type: decimal; -} -.swagger-section .swagger-ui-wrap ol li { - padding: 5px 0px; - font-size: 0.9em; - color: #333333; -} -.swagger-section .swagger-ui-wrap ol, -.swagger-section .swagger-ui-wrap ul { - list-style: none; -} -.swagger-section .swagger-ui-wrap h1 a, -.swagger-section .swagger-ui-wrap h2 a, -.swagger-section .swagger-ui-wrap h3 a, -.swagger-section .swagger-ui-wrap h4 a, -.swagger-section .swagger-ui-wrap h5 a, -.swagger-section .swagger-ui-wrap h6 a { - text-decoration: none; -} -.swagger-section .swagger-ui-wrap h1 a:hover, -.swagger-section .swagger-ui-wrap h2 a:hover, -.swagger-section .swagger-ui-wrap h3 a:hover, -.swagger-section .swagger-ui-wrap h4 a:hover, -.swagger-section .swagger-ui-wrap h5 a:hover, -.swagger-section .swagger-ui-wrap h6 a:hover { - text-decoration: underline; -} -.swagger-section .swagger-ui-wrap h1 span.divider, -.swagger-section .swagger-ui-wrap h2 span.divider, -.swagger-section .swagger-ui-wrap h3 span.divider, -.swagger-section .swagger-ui-wrap h4 span.divider, -.swagger-section .swagger-ui-wrap h5 span.divider, -.swagger-section .swagger-ui-wrap h6 span.divider { - color: #aaaaaa; -} -.swagger-section .swagger-ui-wrap a { - color: #547f00; -} -.swagger-section .swagger-ui-wrap a img { - border: none; -} -.swagger-section .swagger-ui-wrap article, -.swagger-section .swagger-ui-wrap aside, -.swagger-section .swagger-ui-wrap details, -.swagger-section .swagger-ui-wrap figcaption, -.swagger-section .swagger-ui-wrap figure, -.swagger-section .swagger-ui-wrap footer, -.swagger-section .swagger-ui-wrap header, -.swagger-section .swagger-ui-wrap hgroup, -.swagger-section .swagger-ui-wrap menu, -.swagger-section .swagger-ui-wrap nav, -.swagger-section .swagger-ui-wrap section, -.swagger-section .swagger-ui-wrap summary { - display: block; -} -.swagger-section .swagger-ui-wrap pre { - font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace; - background-color: #fcf6db; - border: 1px solid #e5e0c6; - padding: 10px; -} -.swagger-section .swagger-ui-wrap pre code { - line-height: 1.6em; - background: none; -} -.swagger-section .swagger-ui-wrap .content > .content-type > div > label { - clear: both; - display: block; - color: #0F6AB4; - font-size: 1.1em; - margin: 0; - padding: 15px 0 5px; -} -.swagger-section .swagger-ui-wrap .content pre { - font-size: 12px; - margin-top: 5px; - padding: 5px; -} -.swagger-section .swagger-ui-wrap .icon-btn { - cursor: pointer; -} -.swagger-section .swagger-ui-wrap .info_title { - padding-bottom: 10px; - font-weight: bold; - font-size: 25px; -} -.swagger-section .swagger-ui-wrap .footer { - margin-top: 20px; -} -.swagger-section .swagger-ui-wrap p.big, -.swagger-section .swagger-ui-wrap div.big p { - font-size: 1em; - margin-bottom: 10px; -} -.swagger-section .swagger-ui-wrap form.fullwidth ol li.string input, -.swagger-section .swagger-ui-wrap form.fullwidth ol li.url input, -.swagger-section .swagger-ui-wrap form.fullwidth ol li.text textarea, -.swagger-section .swagger-ui-wrap form.fullwidth ol li.numeric input { - width: 500px !important; -} -.swagger-section .swagger-ui-wrap .info_license { - padding-bottom: 5px; -} -.swagger-section .swagger-ui-wrap .info_tos { - padding-bottom: 5px; -} -.swagger-section .swagger-ui-wrap .message-fail { - color: #cc0000; -} -.swagger-section .swagger-ui-wrap .info_url { - padding-bottom: 5px; -} -.swagger-section .swagger-ui-wrap .info_email { - padding-bottom: 5px; -} -.swagger-section .swagger-ui-wrap .info_name { - padding-bottom: 5px; -} -.swagger-section .swagger-ui-wrap .info_description { - padding-bottom: 10px; - font-size: 15px; -} -.swagger-section .swagger-ui-wrap .markdown ol li, -.swagger-section .swagger-ui-wrap .markdown ul li { - padding: 3px 0px; - line-height: 1.4em; - color: #333333; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.string input, -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.url input, -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.numeric input { - display: block; - padding: 4px; - width: auto; - clear: both; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.string input.title, -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.url input.title, -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.numeric input.title { - font-size: 1.3em; -} -.swagger-section .swagger-ui-wrap table.fullwidth { - width: 100%; -} -.swagger-section .swagger-ui-wrap .model-signature { - font-family: "Droid Sans", sans-serif; - font-size: 1em; - line-height: 1.5em; -} -.swagger-section .swagger-ui-wrap .model-signature .signature-nav a { - text-decoration: none; - color: #AAA; -} -.swagger-section .swagger-ui-wrap .model-signature .signature-nav a:hover { - text-decoration: underline; - color: black; -} -.swagger-section .swagger-ui-wrap .model-signature .signature-nav .selected { - color: black; - text-decoration: none; -} -.swagger-section .swagger-ui-wrap .model-signature .propType { - color: #5555aa; -} -.swagger-section .swagger-ui-wrap .model-signature pre:hover { - background-color: #ffffdd; -} -.swagger-section .swagger-ui-wrap .model-signature pre { - font-size: .85em; - line-height: 1.2em; - overflow: auto; - max-height: 200px; - cursor: pointer; -} -.swagger-section .swagger-ui-wrap .model-signature ul.signature-nav { - display: block; - margin: 0; - padding: 0; -} -.swagger-section .swagger-ui-wrap .model-signature ul.signature-nav li:last-child { - padding-right: 0; - border-right: none; -} -.swagger-section .swagger-ui-wrap .model-signature ul.signature-nav li { - float: left; - margin: 0 5px 5px 0; - padding: 2px 5px 2px 0; - border-right: 1px solid #ddd; -} -.swagger-section .swagger-ui-wrap .model-signature .propOpt { - color: #555; -} -.swagger-section .swagger-ui-wrap .model-signature .snippet small { - font-size: 0.75em; -} -.swagger-section .swagger-ui-wrap .model-signature .propOptKey { - font-style: italic; -} -.swagger-section .swagger-ui-wrap .model-signature .description .strong { - font-weight: bold; - color: #000; - font-size: .9em; -} -.swagger-section .swagger-ui-wrap .model-signature .description div { - font-size: 0.9em; - line-height: 1.5em; - margin-left: 1em; -} -.swagger-section .swagger-ui-wrap .model-signature .description .stronger { - font-weight: bold; - color: #000; -} -.swagger-section .swagger-ui-wrap .model-signature .description .propWrap .optionsWrapper { - border-spacing: 0; - position: absolute; - background-color: #ffffff; - border: 1px solid #bbbbbb; - display: none; - font-size: 11px; - max-width: 400px; - line-height: 30px; - color: black; - padding: 5px; - margin-left: 10px; -} -.swagger-section .swagger-ui-wrap .model-signature .description .propWrap .optionsWrapper th { - text-align: center; - background-color: #eeeeee; - border: 1px solid #bbbbbb; - font-size: 11px; - color: #666666; - font-weight: bold; - padding: 5px; - line-height: 15px; -} -.swagger-section .swagger-ui-wrap .model-signature .description .propWrap .optionsWrapper .optionName { - font-weight: bold; -} -.swagger-section .swagger-ui-wrap .model-signature .description .propDesc.markdown > p:first-child, -.swagger-section .swagger-ui-wrap .model-signature .description .propDesc.markdown > p:last-child { - display: inline; -} -.swagger-section .swagger-ui-wrap .model-signature .description .propDesc.markdown > p:not(:first-child):before { - display: block; - content: ''; -} -.swagger-section .swagger-ui-wrap .model-signature .description span:last-of-type.propDesc.markdown > p:only-child { - margin-right: -3px; -} -.swagger-section .swagger-ui-wrap .model-signature .propName { - font-weight: bold; -} -.swagger-section .swagger-ui-wrap .model-signature .signature-container { - clear: both; -} -.swagger-section .swagger-ui-wrap .body-textarea { - width: 300px; - height: 100px; - border: 1px solid #aaa; -} -.swagger-section .swagger-ui-wrap .markdown p code, -.swagger-section .swagger-ui-wrap .markdown li code { - font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace; - background-color: #f0f0f0; - color: black; - padding: 1px 3px; -} -.swagger-section .swagger-ui-wrap .required { - font-weight: bold; -} -.swagger-section .swagger-ui-wrap input.parameter { - width: 300px; - border: 1px solid #aaa; -} -.swagger-section .swagger-ui-wrap h1 { - color: black; - font-size: 1.5em; - line-height: 1.3em; - padding: 10px 0 10px 0; - font-family: "Droid Sans", sans-serif; - font-weight: bold; -} -.swagger-section .swagger-ui-wrap .heading_with_menu { - float: none; - clear: both; - overflow: hidden; - display: block; -} -.swagger-section .swagger-ui-wrap .heading_with_menu ul { - display: block; - clear: none; - float: right; - -moz-box-sizing: border-box; - -webkit-box-sizing: border-box; - -ms-box-sizing: border-box; - box-sizing: border-box; - margin-top: 10px; -} -.swagger-section .swagger-ui-wrap h2 { - color: black; - font-size: 1.3em; - padding: 10px 0 10px 0; -} -.swagger-section .swagger-ui-wrap h2 a { - color: black; -} -.swagger-section .swagger-ui-wrap h2 span.sub { - font-size: 0.7em; - color: #999999; - font-style: italic; -} -.swagger-section .swagger-ui-wrap h2 span.sub a { - color: #777777; -} -.swagger-section .swagger-ui-wrap span.weak { - color: #666666; -} -.swagger-section .swagger-ui-wrap .message-success { - color: #89BF04; -} -.swagger-section .swagger-ui-wrap caption, -.swagger-section .swagger-ui-wrap th, -.swagger-section .swagger-ui-wrap td { - text-align: left; - font-weight: normal; - vertical-align: middle; -} -.swagger-section .swagger-ui-wrap .code { - font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.text textarea { - font-family: "Droid Sans", sans-serif; - height: 250px; - padding: 4px; - display: block; - clear: both; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.select select { - display: block; - clear: both; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.boolean { - float: none; - clear: both; - overflow: hidden; - display: block; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.boolean label { - display: block; - float: left; - clear: none; - margin: 0; - padding: 0; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.boolean input { - display: block; - float: left; - clear: none; - margin: 0 5px 0 0; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.required label { - color: black; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li label { - display: block; - clear: both; - width: auto; - padding: 0 0 3px; - color: #666666; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li label abbr { - padding-left: 3px; - color: #888888; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li p.inline-hints { - margin-left: 0; - font-style: italic; - font-size: 0.9em; - margin: 0; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.buttons { - margin: 0; - padding: 0; -} -.swagger-section .swagger-ui-wrap span.blank, -.swagger-section .swagger-ui-wrap span.empty { - color: #888888; - font-style: italic; -} -.swagger-section .swagger-ui-wrap .markdown h3 { - color: #547f00; -} -.swagger-section .swagger-ui-wrap .markdown h4 { - color: #666666; -} -.swagger-section .swagger-ui-wrap .markdown pre { - font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace; - background-color: #fcf6db; - border: 1px solid #e5e0c6; - padding: 10px; - margin: 0 0 10px 0; -} -.swagger-section .swagger-ui-wrap .markdown pre code { - line-height: 1.6em; -} -.swagger-section .swagger-ui-wrap div.gist { - margin: 20px 0 25px 0 !important; -} -.swagger-section .swagger-ui-wrap ul#resources { - font-family: "Droid Sans", sans-serif; - font-size: 0.9em; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource { - border-bottom: 1px solid #dddddd; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource:hover div.heading h2 a, -.swagger-section .swagger-ui-wrap ul#resources li.resource.active div.heading h2 a { - color: black; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource:hover div.heading ul.options li a, -.swagger-section .swagger-ui-wrap ul#resources li.resource.active div.heading ul.options li a { - color: #555555; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource:last-child { - border-bottom: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading { - border: 1px solid transparent; - float: none; - clear: both; - overflow: hidden; - display: block; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options { - overflow: hidden; - padding: 0; - display: block; - clear: none; - float: right; - margin: 14px 10px 0 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li { - float: left; - clear: none; - margin: 0; - padding: 2px 10px; - border-right: 1px solid #dddddd; - color: #666666; - font-size: 0.9em; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li a { - color: #aaaaaa; - text-decoration: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li a:hover { - text-decoration: underline; - color: black; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li a:hover, -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li a:active, -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li a.active { - text-decoration: underline; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li:first-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li.first { - padding-left: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li.last { - padding-right: 0; - border-right: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options:first-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options.first { - padding-left: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 { - color: #999999; - padding-left: 0; - display: block; - clear: none; - float: left; - font-family: "Droid Sans", sans-serif; - font-weight: bold; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 a { - color: #999999; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 a:hover { - color: black; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation { - float: none; - clear: both; - overflow: hidden; - display: block; - margin: 0 0 10px; - padding: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading { - float: none; - clear: both; - overflow: hidden; - display: block; - margin: 0; - padding: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 { - display: block; - clear: none; - float: left; - width: auto; - margin: 0; - padding: 0; - line-height: 1.1em; - color: black; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 span.path { - padding-left: 10px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 span.path a { - color: black; - text-decoration: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 span.path a:hover { - text-decoration: underline; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 span.http_method a { - text-transform: uppercase; - text-decoration: none; - color: white; - display: inline-block; - width: 50px; - font-size: 0.7em; - text-align: center; - padding: 7px 0 4px; - -moz-border-radius: 2px; - -webkit-border-radius: 2px; - -o-border-radius: 2px; - -ms-border-radius: 2px; - -khtml-border-radius: 2px; - border-radius: 2px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 span { - margin: 0; - padding: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading ul.options { - overflow: hidden; - padding: 0; - display: block; - clear: none; - float: right; - margin: 6px 10px 0 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading ul.options li { - float: left; - clear: none; - margin: 0; - padding: 2px 10px; - font-size: 0.9em; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading ul.options li a { - text-decoration: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading ul.options li.access { - color: black; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content { - border-top: none; - padding: 10px; - -moz-border-radius-bottomleft: 6px; - -webkit-border-bottom-left-radius: 6px; - -o-border-bottom-left-radius: 6px; - -ms-border-bottom-left-radius: 6px; - -khtml-border-bottom-left-radius: 6px; - border-bottom-left-radius: 6px; - -moz-border-radius-bottomright: 6px; - -webkit-border-bottom-right-radius: 6px; - -o-border-bottom-right-radius: 6px; - -ms-border-bottom-right-radius: 6px; - -khtml-border-bottom-right-radius: 6px; - border-bottom-right-radius: 6px; - margin: 0 0 20px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content h4 { - font-size: 1.1em; - margin: 0; - padding: 15px 0 5px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.sandbox_header { - float: none; - clear: both; - overflow: hidden; - display: block; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.sandbox_header a { - padding: 4px 0 0 10px; - display: inline-block; - font-size: 0.9em; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.sandbox_header input.submit { - display: block; - clear: none; - float: left; - padding: 6px 8px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.sandbox_header span.response_throbber { - background-image: url('../images/throbber.gif'); - width: 128px; - height: 16px; - display: block; - clear: none; - float: right; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content form input[type='text'].error { - outline: 2px solid black; - outline-color: #cc0000; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content form select[name='parameterContentType'] { - max-width: 300px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.response div.block pre { - font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace; - padding: 10px; - font-size: 0.9em; - max-height: 400px; - overflow-y: auto; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading { - background-color: #f9f2e9; - border: 1px solid #f0e0ca; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading h3 span.http_method a { - background-color: #c5862b; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #f0e0ca; - color: #c5862b; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading ul.options li a { - color: #c5862b; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.content { - background-color: #faf5ee; - border: 1px solid #f0e0ca; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.content h4 { - color: #c5862b; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.content div.sandbox_header a { - color: #dcb67f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading { - background-color: #fcffcd; - border: 1px solid black; - border-color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading h3 span.http_method a { - text-transform: uppercase; - background-color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #ffd20f; - color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading ul.options li a { - color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.content { - background-color: #fcffcd; - border: 1px solid black; - border-color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.content h4 { - color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.content div.sandbox_header a { - color: #6fc992; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading { - background-color: #f5e8e8; - border: 1px solid #e8c6c7; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading h3 span.http_method a { - text-transform: uppercase; - background-color: #a41e22; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #e8c6c7; - color: #a41e22; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading ul.options li a { - color: #a41e22; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.content { - background-color: #f7eded; - border: 1px solid #e8c6c7; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.content h4 { - color: #a41e22; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.content div.sandbox_header a { - color: #c8787a; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading { - background-color: #e7f6ec; - border: 1px solid #c3e8d1; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading h3 span.http_method a { - background-color: #10a54a; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #c3e8d1; - color: #10a54a; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading ul.options li a { - color: #10a54a; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.content { - background-color: #ebf7f0; - border: 1px solid #c3e8d1; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.content h4 { - color: #10a54a; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.content div.sandbox_header a { - color: #6fc992; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading { - background-color: #FCE9E3; - border: 1px solid #F5D5C3; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading h3 span.http_method a { - background-color: #D38042; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #f0cecb; - color: #D38042; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading ul.options li a { - color: #D38042; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.content { - background-color: #faf0ef; - border: 1px solid #f0cecb; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.content h4 { - color: #D38042; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.content div.sandbox_header a { - color: #dcb67f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading { - background-color: #e7f0f7; - border: 1px solid #c3d9ec; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading h3 span.http_method a { - background-color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #c3d9ec; - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading ul.options li a { - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.content { - background-color: #ebf3f9; - border: 1px solid #c3d9ec; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.content h4 { - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.content div.sandbox_header a { - color: #6fa5d2; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.heading { - background-color: #e7f0f7; - border: 1px solid #c3d9ec; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.heading h3 span.http_method a { - background-color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #c3d9ec; - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.heading ul.options li a { - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.content { - background-color: #ebf3f9; - border: 1px solid #c3d9ec; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.content h4 { - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.content div.sandbox_header a { - color: #6fa5d2; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.content, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.content, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.content, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.content, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.content, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.content { - border-top: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading ul.options li.last, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading ul.options li.last, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading ul.options li.last, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading ul.options li.last, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading ul.options li.last, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading ul.options li.last { - padding-right: 0; - border-right: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations ul.options li a:hover, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations ul.options li a:active, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations ul.options li a.active { - text-decoration: underline; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations ul.options li:first-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations ul.options li.first { - padding-left: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations:first-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations.first { - padding-left: 0; -} -.swagger-section .swagger-ui-wrap p#colophon { - margin: 0 15px 40px 15px; - padding: 10px 0; - font-size: 0.8em; - border-top: 1px solid #dddddd; - font-family: "Droid Sans", sans-serif; - color: #999999; - font-style: italic; -} -.swagger-section .swagger-ui-wrap p#colophon a { - text-decoration: none; - color: #547f00; -} -.swagger-section .swagger-ui-wrap h3 { - color: black; - font-size: 1.1em; - padding: 10px 0 10px 0; -} -.swagger-section .swagger-ui-wrap .markdown ol, -.swagger-section .swagger-ui-wrap .markdown ul { - font-family: "Droid Sans", sans-serif; - margin: 5px 0 10px; - padding: 0 0 0 18px; - list-style-type: disc; -} -.swagger-section .swagger-ui-wrap form.form_box { - background-color: #ebf3f9; - border: 1px solid #c3d9ec; - padding: 10px; -} -.swagger-section .swagger-ui-wrap form.form_box label { - color: #0f6ab4 !important; -} -.swagger-section .swagger-ui-wrap form.form_box input[type=submit] { - display: block; - padding: 10px; -} -.swagger-section .swagger-ui-wrap form.form_box p.weak { - font-size: 0.8em; -} -.swagger-section .swagger-ui-wrap form.form_box p { - font-size: 0.9em; - padding: 0 0 15px; - color: #7e7b6d; -} -.swagger-section .swagger-ui-wrap form.form_box p a { - color: #646257; -} -.swagger-section .swagger-ui-wrap form.form_box p strong { - color: black; -} -.swagger-section .swagger-ui-wrap .operation-status td.markdown > p:last-child { - padding-bottom: 0; -} -.swagger-section .title { - font-style: bold; -} -.swagger-section .secondary_form { - display: none; -} -.swagger-section .main_image { - display: block; - margin-left: auto; - margin-right: auto; -} -.swagger-section .oauth_body { - margin-left: 100px; - margin-right: 100px; -} -.swagger-section .oauth_submit { - text-align: center; -} -.swagger-section .api-popup-dialog { - z-index: 10000; - position: absolute; - width: 500px; - background: #FFF; - padding: 20px; - border: 1px solid #ccc; - border-radius: 5px; - display: none; - font-size: 13px; - color: #777; -} -.swagger-section .api-popup-dialog .api-popup-title { - font-size: 24px; - padding: 10px 0; -} -.swagger-section .api-popup-dialog .api-popup-title { - font-size: 24px; - padding: 10px 0; -} -.swagger-section .api-popup-dialog p.error-msg { - padding-left: 5px; - padding-bottom: 5px; -} -.swagger-section .api-popup-dialog button.api-popup-authbtn { - height: 30px; -} -.swagger-section .api-popup-dialog button.api-popup-cancel { - height: 30px; -} -.swagger-section .api-popup-scopes { - padding: 10px 20px; -} -.swagger-section .api-popup-scopes li { - padding: 5px 0; - line-height: 20px; -} -.swagger-section .api-popup-scopes .api-scope-desc { - padding-left: 20px; - font-style: italic; -} -.swagger-section .api-popup-scopes li input { - position: relative; - top: 2px; -} -.swagger-section .api-popup-actions { - padding-top: 10px; -} -#header { - display: none; -} -.swagger-section .swagger-ui-wrap .model-signature pre { - max-height: none; -} -.swagger-section .swagger-ui-wrap .body-textarea { - width: 100px; -} -.swagger-section .swagger-ui-wrap input.parameter { - width: 100px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options { - display: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints { - display: block !important; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content { - display: block !important; -} diff --git a/src/swagger/css/reset.css b/src/swagger/css/reset.css deleted file mode 100755 index b2b078943c4..00000000000 --- a/src/swagger/css/reset.css +++ /dev/null @@ -1,125 +0,0 @@ -/* http://meyerweb.com/eric/tools/css/reset/ v2.0 | 20110126 */ -html, -body, -div, -span, -applet, -object, -iframe, -h1, -h2, -h3, -h4, -h5, -h6, -p, -blockquote, -pre, -a, -abbr, -acronym, -address, -big, -cite, -code, -del, -dfn, -em, -img, -ins, -kbd, -q, -s, -samp, -small, -strike, -strong, -sub, -sup, -tt, -var, -b, -u, -i, -center, -dl, -dt, -dd, -ol, -ul, -li, -fieldset, -form, -label, -legend, -table, -caption, -tbody, -tfoot, -thead, -tr, -th, -td, -article, -aside, -canvas, -details, -embed, -figure, -figcaption, -footer, -header, -hgroup, -menu, -nav, -output, -ruby, -section, -summary, -time, -mark, -audio, -video { - margin: 0; - padding: 0; - border: 0; - font-size: 100%; - font: inherit; - vertical-align: baseline; -} -/* HTML5 display-role reset for older browsers */ -article, -aside, -details, -figcaption, -figure, -footer, -header, -hgroup, -menu, -nav, -section { - display: block; -} -body { - line-height: 1; -} -ol, -ul { - list-style: none; -} -blockquote, -q { - quotes: none; -} -blockquote:before, -blockquote:after, -q:before, -q:after { - content: ''; - content: none; -} -table { - border-collapse: collapse; - border-spacing: 0; -} diff --git a/src/swagger/css/screen.css b/src/swagger/css/screen.css deleted file mode 100755 index 61509a1b227..00000000000 --- a/src/swagger/css/screen.css +++ /dev/null @@ -1,1281 +0,0 @@ -/* Original style from softwaremaniacs.org (c) Ivan Sagalaev */ -.swagger-section pre code { - display: block; - padding: 0.5em; - background: #F0F0F0; -} -.swagger-section pre code, -.swagger-section pre .subst, -.swagger-section pre .tag .title, -.swagger-section pre .lisp .title, -.swagger-section pre .clojure .built_in, -.swagger-section pre .nginx .title { - color: black; -} -.swagger-section pre .string, -.swagger-section pre .title, -.swagger-section pre .constant, -.swagger-section pre .parent, -.swagger-section pre .tag .value, -.swagger-section pre .rules .value, -.swagger-section pre .rules .value .number, -.swagger-section pre .preprocessor, -.swagger-section pre .ruby .symbol, -.swagger-section pre .ruby .symbol .string, -.swagger-section pre .aggregate, -.swagger-section pre .template_tag, -.swagger-section pre .django .variable, -.swagger-section pre .smalltalk .class, -.swagger-section pre .addition, -.swagger-section pre .flow, -.swagger-section pre .stream, -.swagger-section pre .bash .variable, -.swagger-section pre .apache .tag, -.swagger-section pre .apache .cbracket, -.swagger-section pre .tex .command, -.swagger-section pre .tex .special, -.swagger-section pre .erlang_repl .function_or_atom, -.swagger-section pre .markdown .header { - color: #800; -} -.swagger-section pre .comment, -.swagger-section pre .annotation, -.swagger-section pre .template_comment, -.swagger-section pre .diff .header, -.swagger-section pre .chunk, -.swagger-section pre .markdown .blockquote { - color: #888; -} -.swagger-section pre .number, -.swagger-section pre .date, -.swagger-section pre .regexp, -.swagger-section pre .literal, -.swagger-section pre .smalltalk .symbol, -.swagger-section pre .smalltalk .char, -.swagger-section pre .go .constant, -.swagger-section pre .change, -.swagger-section pre .markdown .bullet, -.swagger-section pre .markdown .link_url { - color: #080; -} -.swagger-section pre .label, -.swagger-section pre .javadoc, -.swagger-section pre .ruby .string, -.swagger-section pre .decorator, -.swagger-section pre .filter .argument, -.swagger-section pre .localvars, -.swagger-section pre .array, -.swagger-section pre .attr_selector, -.swagger-section pre .important, -.swagger-section pre .pseudo, -.swagger-section pre .pi, -.swagger-section pre .doctype, -.swagger-section pre .deletion, -.swagger-section pre .envvar, -.swagger-section pre .shebang, -.swagger-section pre .apache .sqbracket, -.swagger-section pre .nginx .built_in, -.swagger-section pre .tex .formula, -.swagger-section pre .erlang_repl .reserved, -.swagger-section pre .prompt, -.swagger-section pre .markdown .link_label, -.swagger-section pre .vhdl .attribute, -.swagger-section pre .clojure .attribute, -.swagger-section pre .coffeescript .property { - color: #88F; -} -.swagger-section pre .keyword, -.swagger-section pre .id, -.swagger-section pre .phpdoc, -.swagger-section pre .title, -.swagger-section pre .built_in, -.swagger-section pre .aggregate, -.swagger-section pre .css .tag, -.swagger-section pre .javadoctag, -.swagger-section pre .phpdoc, -.swagger-section pre .yardoctag, -.swagger-section pre .smalltalk .class, -.swagger-section pre .winutils, -.swagger-section pre .bash .variable, -.swagger-section pre .apache .tag, -.swagger-section pre .go .typename, -.swagger-section pre .tex .command, -.swagger-section pre .markdown .strong, -.swagger-section pre .request, -.swagger-section pre .status { - font-weight: bold; -} -.swagger-section pre .markdown .emphasis { - font-style: italic; -} -.swagger-section pre .nginx .built_in { - font-weight: normal; -} -.swagger-section pre .coffeescript .javascript, -.swagger-section pre .javascript .xml, -.swagger-section pre .tex .formula, -.swagger-section pre .xml .javascript, -.swagger-section pre .xml .vbscript, -.swagger-section pre .xml .css, -.swagger-section pre .xml .cdata { - opacity: 0.5; -} -.swagger-section .swagger-ui-wrap { - line-height: 1; - font-family: "Droid Sans", sans-serif; - max-width: 960px; - margin-left: auto; - margin-right: auto; -} -.swagger-section .swagger-ui-wrap b, -.swagger-section .swagger-ui-wrap strong { - font-family: "Droid Sans", sans-serif; - font-weight: bold; -} -.swagger-section .swagger-ui-wrap q, -.swagger-section .swagger-ui-wrap blockquote { - quotes: none; -} -.swagger-section .swagger-ui-wrap p { - line-height: 1.4em; - padding: 0 0 10px; - color: #333333; -} -.swagger-section .swagger-ui-wrap q:before, -.swagger-section .swagger-ui-wrap q:after, -.swagger-section .swagger-ui-wrap blockquote:before, -.swagger-section .swagger-ui-wrap blockquote:after { - content: none; -} -.swagger-section .swagger-ui-wrap .heading_with_menu h1, -.swagger-section .swagger-ui-wrap .heading_with_menu h2, -.swagger-section .swagger-ui-wrap .heading_with_menu h3, -.swagger-section .swagger-ui-wrap .heading_with_menu h4, -.swagger-section .swagger-ui-wrap .heading_with_menu h5, -.swagger-section .swagger-ui-wrap .heading_with_menu h6 { - display: block; - clear: none; - float: left; - -moz-box-sizing: border-box; - -webkit-box-sizing: border-box; - -ms-box-sizing: border-box; - box-sizing: border-box; - width: 60%; -} -.swagger-section .swagger-ui-wrap table { - border-collapse: collapse; - border-spacing: 0; -} -.swagger-section .swagger-ui-wrap table thead tr th { - padding: 5px; - font-size: 0.9em; - color: #666666; - border-bottom: 1px solid #999999; -} -.swagger-section .swagger-ui-wrap table tbody tr:last-child td { - border-bottom: none; -} -.swagger-section .swagger-ui-wrap table tbody tr.offset { - background-color: #f0f0f0; -} -.swagger-section .swagger-ui-wrap table tbody tr td { - padding: 6px; - font-size: 0.9em; - border-bottom: 1px solid #cccccc; - vertical-align: top; - line-height: 1.3em; -} -.swagger-section .swagger-ui-wrap ol { - margin: 0px 0 10px; - padding: 0 0 0 18px; - list-style-type: decimal; -} -.swagger-section .swagger-ui-wrap ol li { - padding: 5px 0px; - font-size: 0.9em; - color: #333333; -} -.swagger-section .swagger-ui-wrap ol, -.swagger-section .swagger-ui-wrap ul { - list-style: none; -} -.swagger-section .swagger-ui-wrap h1 a, -.swagger-section .swagger-ui-wrap h2 a, -.swagger-section .swagger-ui-wrap h3 a, -.swagger-section .swagger-ui-wrap h4 a, -.swagger-section .swagger-ui-wrap h5 a, -.swagger-section .swagger-ui-wrap h6 a { - text-decoration: none; -} -.swagger-section .swagger-ui-wrap h1 a:hover, -.swagger-section .swagger-ui-wrap h2 a:hover, -.swagger-section .swagger-ui-wrap h3 a:hover, -.swagger-section .swagger-ui-wrap h4 a:hover, -.swagger-section .swagger-ui-wrap h5 a:hover, -.swagger-section .swagger-ui-wrap h6 a:hover { - text-decoration: underline; -} -.swagger-section .swagger-ui-wrap h1 span.divider, -.swagger-section .swagger-ui-wrap h2 span.divider, -.swagger-section .swagger-ui-wrap h3 span.divider, -.swagger-section .swagger-ui-wrap h4 span.divider, -.swagger-section .swagger-ui-wrap h5 span.divider, -.swagger-section .swagger-ui-wrap h6 span.divider { - color: #aaaaaa; -} -.swagger-section .swagger-ui-wrap a { - color: #547f00; -} -.swagger-section .swagger-ui-wrap a img { - border: none; -} -.swagger-section .swagger-ui-wrap article, -.swagger-section .swagger-ui-wrap aside, -.swagger-section .swagger-ui-wrap details, -.swagger-section .swagger-ui-wrap figcaption, -.swagger-section .swagger-ui-wrap figure, -.swagger-section .swagger-ui-wrap footer, -.swagger-section .swagger-ui-wrap header, -.swagger-section .swagger-ui-wrap hgroup, -.swagger-section .swagger-ui-wrap menu, -.swagger-section .swagger-ui-wrap nav, -.swagger-section .swagger-ui-wrap section, -.swagger-section .swagger-ui-wrap summary { - display: block; -} -.swagger-section .swagger-ui-wrap pre { - font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace; - background-color: #fcf6db; - border: 1px solid #e5e0c6; - padding: 10px; -} -.swagger-section .swagger-ui-wrap pre code { - line-height: 1.6em; - background: none; -} -.swagger-section .swagger-ui-wrap .content > .content-type > div > label { - clear: both; - display: block; - color: #0F6AB4; - font-size: 1.1em; - margin: 0; - padding: 15px 0 5px; -} -.swagger-section .swagger-ui-wrap .content pre { - font-size: 12px; - margin-top: 5px; - padding: 5px; -} -.swagger-section .swagger-ui-wrap .icon-btn { - cursor: pointer; -} -.swagger-section .swagger-ui-wrap .info_title { - padding-bottom: 10px; - font-weight: bold; - font-size: 25px; -} -.swagger-section .swagger-ui-wrap .footer { - margin-top: 20px; -} -.swagger-section .swagger-ui-wrap p.big, -.swagger-section .swagger-ui-wrap div.big p { - font-size: 1em; - margin-bottom: 10px; -} -.swagger-section .swagger-ui-wrap form.fullwidth ol li.string input, -.swagger-section .swagger-ui-wrap form.fullwidth ol li.url input, -.swagger-section .swagger-ui-wrap form.fullwidth ol li.text textarea, -.swagger-section .swagger-ui-wrap form.fullwidth ol li.numeric input { - width: 500px !important; -} -.swagger-section .swagger-ui-wrap .info_license { - padding-bottom: 5px; -} -.swagger-section .swagger-ui-wrap .info_tos { - padding-bottom: 5px; -} -.swagger-section .swagger-ui-wrap .message-fail { - color: #cc0000; -} -.swagger-section .swagger-ui-wrap .info_url { - padding-bottom: 5px; -} -.swagger-section .swagger-ui-wrap .info_email { - padding-bottom: 5px; -} -.swagger-section .swagger-ui-wrap .info_name { - padding-bottom: 5px; -} -.swagger-section .swagger-ui-wrap .info_description { - padding-bottom: 10px; - font-size: 15px; -} -.swagger-section .swagger-ui-wrap .markdown ol li, -.swagger-section .swagger-ui-wrap .markdown ul li { - padding: 3px 0px; - line-height: 1.4em; - color: #333333; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.string input, -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.url input, -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.numeric input { - display: block; - padding: 4px; - width: auto; - clear: both; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.string input.title, -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.url input.title, -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.numeric input.title { - font-size: 1.3em; -} -.swagger-section .swagger-ui-wrap table.fullwidth { - width: 100%; -} -.swagger-section .swagger-ui-wrap .model-signature { - font-family: "Droid Sans", sans-serif; - font-size: 1em; - line-height: 1.5em; -} -.swagger-section .swagger-ui-wrap .model-signature .signature-nav a { - text-decoration: none; - color: #AAA; -} -.swagger-section .swagger-ui-wrap .model-signature .signature-nav a:hover { - text-decoration: underline; - color: black; -} -.swagger-section .swagger-ui-wrap .model-signature .signature-nav .selected { - color: black; - text-decoration: none; -} -.swagger-section .swagger-ui-wrap .model-signature .propType { - color: #5555aa; -} -.swagger-section .swagger-ui-wrap .model-signature pre:hover { - background-color: #ffffdd; -} -.swagger-section .swagger-ui-wrap .model-signature pre { - font-size: .85em; - line-height: 1.2em; - overflow: auto; - max-height: 200px; - cursor: pointer; -} -.swagger-section .swagger-ui-wrap .model-signature ul.signature-nav { - display: block; - margin: 0; - padding: 0; -} -.swagger-section .swagger-ui-wrap .model-signature ul.signature-nav li:last-child { - padding-right: 0; - border-right: none; -} -.swagger-section .swagger-ui-wrap .model-signature ul.signature-nav li { - float: left; - margin: 0 5px 5px 0; - padding: 2px 5px 2px 0; - border-right: 1px solid #ddd; -} -.swagger-section .swagger-ui-wrap .model-signature .propOpt { - color: #555; -} -.swagger-section .swagger-ui-wrap .model-signature .snippet small { - font-size: 0.75em; -} -.swagger-section .swagger-ui-wrap .model-signature .propOptKey { - font-style: italic; -} -.swagger-section .swagger-ui-wrap .model-signature .description .strong { - font-weight: bold; - color: #000; - font-size: .9em; -} -.swagger-section .swagger-ui-wrap .model-signature .description div { - font-size: 0.9em; - line-height: 1.5em; - margin-left: 1em; -} -.swagger-section .swagger-ui-wrap .model-signature .description .stronger { - font-weight: bold; - color: #000; -} -.swagger-section .swagger-ui-wrap .model-signature .description .propWrap .optionsWrapper { - border-spacing: 0; - position: absolute; - background-color: #ffffff; - border: 1px solid #bbbbbb; - display: none; - font-size: 11px; - max-width: 400px; - line-height: 30px; - color: black; - padding: 5px; - margin-left: 10px; -} -.swagger-section .swagger-ui-wrap .model-signature .description .propWrap .optionsWrapper th { - text-align: center; - background-color: #eeeeee; - border: 1px solid #bbbbbb; - font-size: 11px; - color: #666666; - font-weight: bold; - padding: 5px; - line-height: 15px; -} -.swagger-section .swagger-ui-wrap .model-signature .description .propWrap .optionsWrapper .optionName { - font-weight: bold; -} -.swagger-section .swagger-ui-wrap .model-signature .description .propDesc.markdown > p:first-child, -.swagger-section .swagger-ui-wrap .model-signature .description .propDesc.markdown > p:last-child { - display: inline; -} -.swagger-section .swagger-ui-wrap .model-signature .description .propDesc.markdown > p:not(:first-child):before { - display: block; - content: ''; -} -.swagger-section .swagger-ui-wrap .model-signature .description span:last-of-type.propDesc.markdown > p:only-child { - margin-right: -3px; -} -.swagger-section .swagger-ui-wrap .model-signature .propName { - font-weight: bold; -} -.swagger-section .swagger-ui-wrap .model-signature .signature-container { - clear: both; -} -.swagger-section .swagger-ui-wrap .body-textarea { - width: 300px; - height: 100px; - border: 1px solid #aaa; -} -.swagger-section .swagger-ui-wrap .markdown p code, -.swagger-section .swagger-ui-wrap .markdown li code { - font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace; - background-color: #f0f0f0; - color: black; - padding: 1px 3px; -} -.swagger-section .swagger-ui-wrap .required { - font-weight: bold; -} -.swagger-section .swagger-ui-wrap input.parameter { - width: 300px; - border: 1px solid #aaa; -} -.swagger-section .swagger-ui-wrap h1 { - color: black; - font-size: 1.5em; - line-height: 1.3em; - padding: 10px 0 10px 0; - font-family: "Droid Sans", sans-serif; - font-weight: bold; -} -.swagger-section .swagger-ui-wrap .heading_with_menu { - float: none; - clear: both; - overflow: hidden; - display: block; -} -.swagger-section .swagger-ui-wrap .heading_with_menu ul { - display: block; - clear: none; - float: right; - -moz-box-sizing: border-box; - -webkit-box-sizing: border-box; - -ms-box-sizing: border-box; - box-sizing: border-box; - margin-top: 10px; -} -.swagger-section .swagger-ui-wrap h2 { - color: black; - font-size: 1.3em; - padding: 10px 0 10px 0; -} -.swagger-section .swagger-ui-wrap h2 a { - color: black; -} -.swagger-section .swagger-ui-wrap h2 span.sub { - font-size: 0.7em; - color: #999999; - font-style: italic; -} -.swagger-section .swagger-ui-wrap h2 span.sub a { - color: #777777; -} -.swagger-section .swagger-ui-wrap span.weak { - color: #666666; -} -.swagger-section .swagger-ui-wrap .message-success { - color: #89BF04; -} -.swagger-section .swagger-ui-wrap caption, -.swagger-section .swagger-ui-wrap th, -.swagger-section .swagger-ui-wrap td { - text-align: left; - font-weight: normal; - vertical-align: middle; -} -.swagger-section .swagger-ui-wrap .code { - font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.text textarea { - font-family: "Droid Sans", sans-serif; - height: 250px; - padding: 4px; - display: block; - clear: both; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.select select { - display: block; - clear: both; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.boolean { - float: none; - clear: both; - overflow: hidden; - display: block; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.boolean label { - display: block; - float: left; - clear: none; - margin: 0; - padding: 0; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.boolean input { - display: block; - float: left; - clear: none; - margin: 0 5px 0 0; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li.required label { - color: black; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li label { - display: block; - clear: both; - width: auto; - padding: 0 0 3px; - color: #666666; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li label abbr { - padding-left: 3px; - color: #888888; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.inputs ol li p.inline-hints { - margin-left: 0; - font-style: italic; - font-size: 0.9em; - margin: 0; -} -.swagger-section .swagger-ui-wrap form.formtastic fieldset.buttons { - margin: 0; - padding: 0; -} -.swagger-section .swagger-ui-wrap span.blank, -.swagger-section .swagger-ui-wrap span.empty { - color: #888888; - font-style: italic; -} -.swagger-section .swagger-ui-wrap .markdown h3 { - color: #547f00; -} -.swagger-section .swagger-ui-wrap .markdown h4 { - color: #666666; -} -.swagger-section .swagger-ui-wrap .markdown pre { - font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace; - background-color: #fcf6db; - border: 1px solid #e5e0c6; - padding: 10px; - margin: 0 0 10px 0; -} -.swagger-section .swagger-ui-wrap .markdown pre code { - line-height: 1.6em; -} -.swagger-section .swagger-ui-wrap div.gist { - margin: 20px 0 25px 0 !important; -} -.swagger-section .swagger-ui-wrap ul#resources { - font-family: "Droid Sans", sans-serif; - font-size: 0.9em; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource { - border-bottom: 1px solid #dddddd; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource:hover div.heading h2 a, -.swagger-section .swagger-ui-wrap ul#resources li.resource.active div.heading h2 a { - color: black; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource:hover div.heading ul.options li a, -.swagger-section .swagger-ui-wrap ul#resources li.resource.active div.heading ul.options li a { - color: #555555; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource:last-child { - border-bottom: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading { - border: 1px solid transparent; - float: none; - clear: both; - overflow: hidden; - display: block; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options { - overflow: hidden; - padding: 0; - display: block; - clear: none; - float: right; - margin: 14px 10px 0 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li { - float: left; - clear: none; - margin: 0; - padding: 2px 10px; - border-right: 1px solid #dddddd; - color: #666666; - font-size: 0.9em; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li a { - color: #aaaaaa; - text-decoration: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li a:hover { - text-decoration: underline; - color: black; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li a:hover, -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li a:active, -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li a.active { - text-decoration: underline; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li:first-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li.first { - padding-left: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options li.last { - padding-right: 0; - border-right: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options:first-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading ul.options.first { - padding-left: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 { - color: #999999; - padding-left: 0; - display: block; - clear: none; - float: left; - font-family: "Droid Sans", sans-serif; - font-weight: bold; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 a { - color: #ef672f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 a:hover { - color: black; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation { - float: none; - clear: both; - overflow: hidden; - display: block; - margin: 0 0 10px; - padding: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading { - float: none; - clear: both; - overflow: hidden; - display: block; - margin: 0; - padding: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 { - display: block; - clear: none; - float: left; - width: auto; - margin: 0; - padding: 0; - line-height: 1.1em; - color: black; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 span.path { - padding-left: 10px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 span.path a { - color: black; - text-decoration: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 span.path a:hover { - text-decoration: underline; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 span.http_method a { - text-transform: uppercase; - text-decoration: none; - color: white; - display: inline-block; - width: 50px; - font-size: 0.7em; - text-align: center; - padding: 7px 0 4px; - -moz-border-radius: 2px; - -webkit-border-radius: 2px; - -o-border-radius: 2px; - -ms-border-radius: 2px; - -khtml-border-radius: 2px; - border-radius: 2px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading h3 span { - margin: 0; - padding: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading ul.options { - overflow: hidden; - padding: 0; - display: block; - clear: none; - float: right; - margin: 6px 10px 0 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading ul.options li { - float: left; - clear: none; - margin: 0; - padding: 2px 10px; - font-size: 0.9em; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading ul.options li a { - text-decoration: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.heading ul.options li.access { - color: black; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content { - border-top: none; - padding: 10px; - -moz-border-radius-bottomleft: 6px; - -webkit-border-bottom-left-radius: 6px; - -o-border-bottom-left-radius: 6px; - -ms-border-bottom-left-radius: 6px; - -khtml-border-bottom-left-radius: 6px; - border-bottom-left-radius: 6px; - -moz-border-radius-bottomright: 6px; - -webkit-border-bottom-right-radius: 6px; - -o-border-bottom-right-radius: 6px; - -ms-border-bottom-right-radius: 6px; - -khtml-border-bottom-right-radius: 6px; - border-bottom-right-radius: 6px; - margin: 0 0 20px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content h4 { - font-size: 1.1em; - margin: 0; - padding: 15px 0 5px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.sandbox_header { - float: none; - clear: both; - overflow: hidden; - display: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.sandbox_header a { - padding: 4px 0 0 10px; - display: inline-block; - font-size: 0.9em; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.sandbox_header input.submit { - display: block; - clear: none; - float: left; - padding: 6px 8px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.sandbox_header span.response_throbber { - background-image: url('../images/throbber.gif'); - width: 128px; - height: 16px; - display: block; - clear: none; - float: right; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content form input[type='text'].error { - outline: 2px solid black; - outline-color: #cc0000; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content form select[name='parameterContentType'] { - max-width: 300px; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation div.content div.response div.block pre { - font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace; - padding: 10px; - font-size: 0.9em; - max-height: 400px; - overflow-y: auto; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading { - background-color: #f9f2e9; - border: 1px solid #f0e0ca; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading h3 span.http_method a { - background-color: #c5862b; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #f0e0ca; - color: #c5862b; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading ul.options li a { - color: #c5862b; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.content { - background-color: #faf5ee; - border: 1px solid #f0e0ca; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.content h4 { - color: #c5862b; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.content div.sandbox_header a { - color: #dcb67f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading { - background-color: #fcffcd; - border: 1px solid black; - border-color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading h3 span.http_method a { - text-transform: uppercase; - background-color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #ffd20f; - color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading ul.options li a { - color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.content { - background-color: #fcffcd; - border: 1px solid black; - border-color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.content h4 { - color: #ffd20f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.content div.sandbox_header a { - color: #6fc992; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading { - background-color: #f5e8e8; - border: 1px solid #e8c6c7; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading h3 span.http_method a { - text-transform: uppercase; - background-color: #a41e22; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #e8c6c7; - color: #a41e22; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading ul.options li a { - color: #a41e22; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.content { - background-color: #f7eded; - border: 1px solid #e8c6c7; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.content h4 { - color: #a41e22; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.content div.sandbox_header a { - color: #c8787a; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading { - background-color: #e7f6ec; - border: 1px solid #c3e8d1; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading h3 span.http_method a { - background-color: #10a54a; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #c3e8d1; - color: #10a54a; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading ul.options li a { - color: #10a54a; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.content { - background-color: #ebf7f0; - border: 1px solid #c3e8d1; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.content h4 { - color: #10a54a; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.content div.sandbox_header a { - color: #6fc992; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading { - background-color: #FCE9E3; - border: 1px solid #F5D5C3; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading h3 span.http_method a { - background-color: #D38042; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #f0cecb; - color: #D38042; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading ul.options li a { - color: #D38042; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.content { - background-color: #faf0ef; - border: 1px solid #f0cecb; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.content h4 { - color: #D38042; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.content div.sandbox_header a { - color: #dcb67f; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading { - background-color: #e7f0f7; - border: 1px solid #c3d9ec; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading h3 span.http_method a { - background-color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #c3d9ec; - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading ul.options li a { - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.content { - background-color: #ebf3f9; - border: 1px solid #c3d9ec; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.content h4 { - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.content div.sandbox_header a { - color: #6fa5d2; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.heading { - background-color: #e7f0f7; - border: 1px solid #c3d9ec; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.heading h3 span.http_method a { - background-color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.heading ul.options li { - border-right: 1px solid #dddddd; - border-right-color: #c3d9ec; - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.heading ul.options li a { - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.content { - background-color: #ebf3f9; - border: 1px solid #c3d9ec; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.content h4 { - color: #0f6ab4; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.options div.content div.sandbox_header a { - color: #6fa5d2; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.content, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.content, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.content, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.content, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.content, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.content { - border-top: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading ul.options li:last-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.get div.heading ul.options li.last, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.post div.heading ul.options li.last, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.head div.heading ul.options li.last, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.put div.heading ul.options li.last, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.patch div.heading ul.options li.last, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations li.operation.delete div.heading ul.options li.last { - padding-right: 0; - border-right: none; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations ul.options li a:hover, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations ul.options li a:active, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations ul.options li a.active { - text-decoration: underline; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations ul.options li:first-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations ul.options li.first { - padding-left: 0; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations:first-child, -.swagger-section .swagger-ui-wrap ul#resources li.resource ul.endpoints li.endpoint ul.operations.first { - padding-left: 0; -} -.swagger-section .swagger-ui-wrap p#colophon { - margin: 0 15px 40px 15px; - padding: 10px 0; - font-size: 0.8em; - border-top: 1px solid #dddddd; - font-family: "Droid Sans", sans-serif; - color: #999999; - font-style: italic; -} -.swagger-section .swagger-ui-wrap p#colophon a { - text-decoration: none; - color: #547f00; -} -.swagger-section .swagger-ui-wrap h3 { - color: black; - font-size: 1.1em; - padding: 10px 0 10px 0; -} -.swagger-section .swagger-ui-wrap .markdown ol, -.swagger-section .swagger-ui-wrap .markdown ul { - font-family: "Droid Sans", sans-serif; - margin: 5px 0 10px; - padding: 0 0 0 18px; - list-style-type: disc; -} -.swagger-section .swagger-ui-wrap form.form_box { - background-color: #ebf3f9; - border: 1px solid #c3d9ec; - padding: 10px; -} -.swagger-section .swagger-ui-wrap form.form_box label { - color: #0f6ab4 !important; -} -.swagger-section .swagger-ui-wrap form.form_box input[type=submit] { - display: block; - padding: 10px; -} -.swagger-section .swagger-ui-wrap form.form_box p.weak { - font-size: 0.8em; -} -.swagger-section .swagger-ui-wrap form.form_box p { - font-size: 0.9em; - padding: 0 0 15px; - color: #7e7b6d; -} -.swagger-section .swagger-ui-wrap form.form_box p a { - color: #646257; -} -.swagger-section .swagger-ui-wrap form.form_box p strong { - color: black; -} -.swagger-section .swagger-ui-wrap .operation-status td.markdown > p:last-child { - padding-bottom: 0; -} -.swagger-section .title { - font-style: bold; -} -.swagger-section .secondary_form { - display: none; -} -.swagger-section .main_image { - display: block; - margin-left: auto; - margin-right: auto; -} -.swagger-section .oauth_body { - margin-left: 100px; - margin-right: 100px; -} -.swagger-section .oauth_submit { - text-align: center; -} -.swagger-section .api-popup-dialog { - z-index: 10000; - position: absolute; - width: 500px; - background: #FFF; - padding: 20px; - border: 1px solid #ccc; - border-radius: 5px; - display: none; - font-size: 13px; - color: #777; -} -.swagger-section .api-popup-dialog .api-popup-title { - font-size: 24px; - padding: 10px 0; -} -.swagger-section .api-popup-dialog .api-popup-title { - font-size: 24px; - padding: 10px 0; -} -.swagger-section .api-popup-dialog p.error-msg { - padding-left: 5px; - padding-bottom: 5px; -} -.swagger-section .api-popup-dialog button.api-popup-authbtn { - height: 30px; -} -.swagger-section .api-popup-dialog button.api-popup-cancel { - height: 30px; -} -.swagger-section .api-popup-scopes { - padding: 10px 20px; -} -.swagger-section .api-popup-scopes li { - padding: 5px 0; - line-height: 20px; -} -.swagger-section .api-popup-scopes .api-scope-desc { - padding-left: 20px; - font-style: italic; -} -.swagger-section .api-popup-scopes li input { - position: relative; - top: 2px; -} -.swagger-section .api-popup-actions { - padding-top: 10px; -} -.swagger-section .access { - float: right; -} -.swagger-section .auth { - float: right; -} -.swagger-section .api-ic { - height: 18px; - vertical-align: middle; - display: inline-block; - background: url(../images/explorer_icons.png) no-repeat; -} -.swagger-section .api-ic .api_information_panel { - position: relative; - margin-top: 20px; - margin-left: -5px; - background: #FFF; - border: 1px solid #ccc; - border-radius: 5px; - display: none; - font-size: 13px; - max-width: 300px; - line-height: 30px; - color: black; - padding: 5px; -} -.swagger-section .api-ic .api_information_panel p .api-msg-enabled { - color: green; -} -.swagger-section .api-ic .api_information_panel p .api-msg-disabled { - color: red; -} -.swagger-section .api-ic:hover .api_information_panel { - position: absolute; - display: block; -} -.swagger-section .ic-info { - background-position: 0 0; - width: 18px; - margin-top: -6px; - margin-left: 4px; -} -.swagger-section .ic-warning { - background-position: -60px 0; - width: 18px; - margin-top: -6px; - margin-left: 4px; -} -.swagger-section .ic-error { - background-position: -30px 0; - width: 18px; - margin-top: -6px; - margin-left: 4px; -} -.swagger-section .ic-off { - background-position: -90px 0; - width: 58px; - margin-top: -4px; - cursor: pointer; -} -.swagger-section .ic-on { - background-position: -160px 0; - width: 58px; - margin-top: -4px; - cursor: pointer; -} -.swagger-section #header { - background-color: #ef672f; - padding: 14px; -} -.swagger-section #header a#logo { - font-size: 1.5em; - font-weight: bold; - text-decoration: none; - padding: 12px 0 12px 80px; - color: white; -} -.swagger-section #header form#api_selector { - display: block; - clear: none; - float: right; -} -.swagger-section #header form#api_selector .input { - display: block; - clear: none; - float: left; - margin: 0 10px 0 0; -} -.swagger-section #header form#api_selector .input input#input_apiKey { - width: 200px; -} -.swagger-section #header form#api_selector .input input#input_baseUrl { - width: 400px; -} -.swagger-section #header form#api_selector .input a#explore { - display: block; - text-decoration: none; - font-weight: bold; - padding: 6px 8px; - font-size: 0.9em; - color: white; - background-color: #bf5225; - -moz-border-radius: 4px; - -webkit-border-radius: 4px; - -o-border-radius: 4px; - -ms-border-radius: 4px; - -khtml-border-radius: 4px; - border-radius: 4px; -} -.swagger-section #header form#api_selector .input a#explore:hover { - background-color: #547f00; -} -.swagger-section #header form#api_selector .input input { - font-size: 0.9em; - padding: 3px; - margin: 0; -} -.swagger-section #content_message { - margin: 10px 15px; - font-style: italic; - color: #999999; -} -.swagger-section #message-bar { - min-height: 30px; - text-align: center; - padding-top: 10px; -} diff --git a/src/swagger/css/style.css b/src/swagger/css/style.css deleted file mode 100755 index fc21a31db54..00000000000 --- a/src/swagger/css/style.css +++ /dev/null @@ -1,250 +0,0 @@ -.swagger-section #header a#logo { - font-size: 1.5em; - font-weight: bold; - text-decoration: none; - background: transparent url(../images/logo.png) no-repeat left center; - padding: 20px 0 20px 40px; -} -#text-head { - font-size: 80px; - font-family: 'Roboto', sans-serif; - color: #ffffff; - float: right; - margin-right: 20%; -} -.navbar-fixed-top .navbar-nav { - height: auto; -} -.navbar-fixed-top .navbar-brand { - height: auto; -} -.navbar-header { - height: auto; -} -.navbar-inverse { - background-color: #000; - border-color: #000; -} -#navbar-brand { - margin-left: 20%; -} -.navtext { - font-size: 10px; -} -.h1, -h1 { - font-size: 60px; -} -.navbar-default .navbar-header .navbar-brand { - color: #a2dfee; -} -/* tag titles */ -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 a { - color: #393939; - font-family: 'Arvo', serif; - font-size: 1.5em; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 a:hover { - color: black; -} -.swagger-section .swagger-ui-wrap ul#resources li.resource div.heading h2 { - color: #525252; - padding-left: 0px; - display: block; - clear: none; - float: left; - font-family: 'Arvo', serif; - font-weight: bold; -} -.navbar-default .navbar-collapse, -.navbar-default .navbar-form { - border-color: #0A0A0A; -} -.container1 { - width: 1500px; - margin: auto; - margin-top: 0; - background-image: url('../images/shield.png'); - background-repeat: no-repeat; - background-position: -40px -20px; - margin-bottom: 210px; -} -.container-inner { - width: 1200px; - margin: auto; - background-color: rgba(223, 227, 228, 0.75); - padding-bottom: 40px; - padding-top: 40px; - border-radius: 15px; -} -.header-content { - padding: 0; - width: 1000px; -} -.title1 { - font-size: 80px; - font-family: 'Vollkorn', serif; - color: #404040; - text-align: center; - padding-top: 40px; - padding-bottom: 100px; -} -#icon { - margin-top: -18px; -} -.subtext { - font-size: 25px; - font-style: italic; - color: #08b; - text-align: right; - padding-right: 250px; -} -.bg-primary { - background-color: #00468b; -} -.navbar-default .nav > li > a, -.navbar-default .nav > li > a:focus { - color: #08b; -} -.navbar-default .nav > li > a, -.navbar-default .nav > li > a:hover { - color: #08b; -} -.navbar-default .nav > li > a, -.navbar-default .nav > li > a:focus:hover { - color: #08b; -} -.text-faded { - font-size: 25px; - font-family: 'Vollkorn', serif; -} -.section-heading { - font-family: 'Vollkorn', serif; - font-size: 45px; - padding-bottom: 10px; -} -hr { - border-color: #00468b; - padding-bottom: 10px; -} -.description { - margin-top: 20px; - padding-bottom: 200px; -} -.description li { - font-family: 'Vollkorn', serif; - font-size: 25px; - color: #525252; - margin-left: 28%; - padding-top: 5px; -} -.gap { - margin-top: 200px; -} -.troubleshootingtext { - color: rgba(255, 255, 255, 0.7); - padding-left: 30%; -} -.troubleshootingtext li { - list-style-type: circle; - font-size: 25px; - padding-bottom: 5px; -} -.overlay { - position: absolute; - top: 0; - left: 0; - width: 100%; - height: 100%; - z-index: 1000; -} -.block.response_body.json:hover { - cursor: pointer; -} -.backdrop { - color: blue; -} -#myModal { - height: 100%; -} -.modal-backdrop { - bottom: 0; - position: fixed; -} -.curl { - padding: 10px; - font-family: "Anonymous Pro", "Menlo", "Consolas", "Bitstream Vera Sans Mono", "Courier New", monospace; - font-size: 0.9em; - max-height: 400px; - margin-top: 5px; - overflow-y: auto; - background-color: #fcf6db; - border: 1px solid #e5e0c6; - border-radius: 4px; -} -.curl_title { - font-size: 1.1em; - margin: 0; - padding: 15px 0 5px; - font-family: 'Open Sans', 'Helvetica Neue', Arial, sans-serif; - font-weight: 500; - line-height: 1.1; -} -.footer { - display: none; -} -.swagger-section .swagger-ui-wrap h2 { - padding: 0; -} -h2 { - margin: 0; - margin-bottom: 5px; -} -.markdown p { - font-size: 15px; - font-family: 'Arvo', serif; -} -.swagger-section .swagger-ui-wrap .code { - font-size: 15px; - font-family: 'Arvo', serif; -} -.swagger-section .swagger-ui-wrap b { - font-family: 'Arvo', serif; -} -#signin:hover { - cursor: pointer; -} -.dropdown-menu { - padding: 15px; -} -.navbar-right .dropdown-menu { - left: 0; - right: auto; -} -#signinbutton { - width: 100%; - height: 32px; - font-size: 13px; - font-weight: bold; - color: #08b; -} -.navbar-default .nav > li .details { - color: #000000; - text-transform: none; - font-size: 15px; - font-weight: normal; - font-family: 'Open Sans', sans-serif; - font-style: italic; - line-height: 20px; - top: -2px; -} -.navbar-default .nav > li .details:hover { - color: black; -} -#signout { - width: 100%; - height: 32px; - font-size: 13px; - font-weight: bold; - color: #08b; -} diff --git a/src/swagger/css/theme.css b/src/swagger/css/theme.css deleted file mode 100644 index 64fb3a4523d..00000000000 --- a/src/swagger/css/theme.css +++ /dev/null @@ -1,1684 +0,0 @@ -.swagger-ui html { - box-sizing: border-box -} - -.swagger-ui *, .swagger-ui :after, .swagger-ui :before { - box-sizing: inherit -} - -.swagger-ui body { - margin: 0; - background: #fafafa -} - -.swagger-ui .wrapper { - width: 100%; - max-width: 1460px; - margin: 0 auto; - padding: 0 20px -} - -.swagger-ui .opblock-tag-section { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - -webkit-box-orient: vertical; - -webkit-box-direction: normal; - -ms-flex-direction: column; - flex-direction: column -} - -.swagger-ui .opblock-tag { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - padding: 10px 20px 10px 10px; - cursor: pointer; - -webkit-transition: all .2s; - transition: all .2s; - border-bottom: 1px solid rgba(59, 65, 81, .3); - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center -} - -.swagger-ui .opblock-tag:hover { - background: rgba(0, 0, 0, .02) -} - -.swagger-ui .opblock-tag { - font-size: 24px; - margin: 0 0 5px; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui .opblock-tag.no-desc span { - -webkit-box-flex: 1; - -ms-flex: 1; - flex: 1 -} - -.swagger-ui .opblock-tag svg { - -webkit-transition: all .4s; - transition: all .4s -} - -.swagger-ui .opblock-tag small { - font-size: 14px; - font-weight: 400; - padding: 0 10px; - -webkit-box-flex: 1; - -ms-flex: 1; - flex: 1; - font-family: Open Sans, sans-serif; - color: #3b4151 -} - -.swagger-ui .parаmeter__type { - font-size: 12px; - padding: 5px 0; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #3b4151 -} - -.swagger-ui .view-line-link { - position: relative; - top: 3px; - width: 20px; - margin: 0 5px; - cursor: pointer; - -webkit-transition: all .5s; - transition: all .5s -} - -.swagger-ui .opblock { - margin: 0 0 15px; - border: 1px solid #000; - border-radius: 4px; - box-shadow: 0 0 3px rgba(0, 0, 0, .19) -} - -.swagger-ui .opblock.is-open .opblock-summary { - border-bottom: 1px solid #000 -} - -.swagger-ui .opblock .opblock-section-header { - padding: 8px 20px; - background: hsla(0, 0%, 100%, .8); - box-shadow: 0 1px 2px rgba(0, 0, 0, .1) -} - -.swagger-ui .opblock .opblock-section-header, .swagger-ui .opblock .opblock-section-header label { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center -} - -.swagger-ui .opblock .opblock-section-header label { - font-size: 12px; - font-weight: 700; - margin: 0; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui .opblock .opblock-section-header label span { - padding: 0 10px 0 0 -} - -.swagger-ui .opblock .opblock-section-header h4 { - font-size: 14px; - margin: 0; - -webkit-box-flex: 1; - -ms-flex: 1; - flex: 1; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui .opblock .opblock-summary-method { - font-size: 14px; - font-weight: 700; - min-width: 80px; - padding: 6px 15px; - text-align: center; - border-radius: 3px; - background: #000; - text-shadow: 0 1px 0 rgba(0, 0, 0, .1); - font-family: Titillium Web, sans-serif; - color: #fff -} - -.swagger-ui .opblock .opblock-summary-path, .swagger-ui .opblock .opblock-summary-path__deprecated { - font-size: 16px; - display: -webkit-box; - display: -ms-flexbox; - display: flex; - padding: 0 10px; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #3b4151; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center -} - -.swagger-ui .opblock .opblock-summary-path .view-line-link, .swagger-ui .opblock .opblock-summary-path__deprecated .view-line-link { - position: relative; - top: 2px; - width: 0; - margin: 0; - cursor: pointer; - -webkit-transition: all .5s; - transition: all .5s -} - -.swagger-ui .opblock .opblock-summary-path:hover .view-line-link, .swagger-ui .opblock .opblock-summary-path__deprecated:hover .view-line-link { - width: 18px; - margin: 0 5px -} - -.swagger-ui .opblock .opblock-summary-path__deprecated { - text-decoration: line-through -} - -.swagger-ui .opblock .opblock-summary-description { - font-size: 13px; - -webkit-box-flex: 1; - -ms-flex: 1; - flex: 1; - font-family: Open Sans, sans-serif; - color: #3b4151 -} - -.swagger-ui .opblock .opblock-summary { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - padding: 5px; - cursor: pointer; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center -} - -.swagger-ui .opblock.opblock-post { - border-color: #49cc90; - background: rgba(73, 204, 144, .1) -} - -.swagger-ui .opblock.opblock-post .opblock-summary-method { - background: #49cc90 -} - -.swagger-ui .opblock.opblock-post .opblock-summary { - border-color: #49cc90 -} - -.swagger-ui .opblock.opblock-put { - border-color: #fca130; - background: rgba(252, 161, 48, .1) -} - -.swagger-ui .opblock.opblock-put .opblock-summary-method { - background: #fca130 -} - -.swagger-ui .opblock.opblock-put .opblock-summary { - border-color: #fca130 -} - -.swagger-ui .opblock.opblock-delete { - border-color: #f93e3e; - background: rgba(249, 62, 62, .1) -} - -.swagger-ui .opblock.opblock-delete .opblock-summary-method { - background: #f93e3e -} - -.swagger-ui .opblock.opblock-delete .opblock-summary { - border-color: #f93e3e -} - -.swagger-ui .opblock.opblock-get { - border-color: #61affe; - background: rgba(97, 175, 254, .1) -} - -.swagger-ui .opblock.opblock-get .opblock-summary-method { - background: #61affe -} - -.swagger-ui .opblock.opblock-get .opblock-summary { - border-color: #61affe -} - -.swagger-ui .opblock.opblock-patch { - border-color: #50e3c2; - background: rgba(80, 227, 194, .1) -} - -.swagger-ui .opblock.opblock-patch .opblock-summary-method { - background: #50e3c2 -} - -.swagger-ui .opblock.opblock-patch .opblock-summary { - border-color: #50e3c2 -} - -.swagger-ui .opblock.opblock-head { - border-color: #9012fe; - background: rgba(144, 18, 254, .1) -} - -.swagger-ui .opblock.opblock-head .opblock-summary-method { - background: #9012fe -} - -.swagger-ui .opblock.opblock-head .opblock-summary { - border-color: #9012fe -} - -.swagger-ui .opblock.opblock-options { - border-color: #0d5aa7; - background: rgba(13, 90, 167, .1) -} - -.swagger-ui .opblock.opblock-options .opblock-summary-method { - background: #0d5aa7 -} - -.swagger-ui .opblock.opblock-options .opblock-summary { - border-color: #0d5aa7 -} - -.swagger-ui .opblock.opblock-deprecated { - opacity: .6; - border-color: #ebebeb; - background: hsla(0, 0%, 92%, .1) -} - -.swagger-ui .opblock.opblock-deprecated .opblock-summary-method { - background: #ebebeb -} - -.swagger-ui .opblock.opblock-deprecated .opblock-summary { - border-color: #ebebeb -} - -.swagger-ui .tab { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - margin: 20px 0 10px; - padding: 0; - list-style: none -} - -.swagger-ui .tab li { - font-size: 12px; - min-width: 100px; - min-width: 90px; - padding: 0; - cursor: pointer; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui .tab li:first-of-type { - position: relative; - padding-left: 0 -} - -.swagger-ui .tab li:first-of-type:after { - position: absolute; - top: 0; - right: 6px; - width: 1px; - height: 100%; - content: ""; - background: rgba(0, 0, 0, .2) -} - -.swagger-ui .tab li.active { - font-weight: 700 -} - -.swagger-ui .opblock-description-wrapper, .swagger-ui .opblock-title_normal { - padding: 15px 20px -} - -.swagger-ui .opblock-description-wrapper, .swagger-ui .opblock-description-wrapper h4, .swagger-ui .opblock-title_normal, .swagger-ui .opblock-title_normal h4 { - font-size: 12px; - margin: 0 0 5px; - font-family: Open Sans, sans-serif; - color: #3b4151 -} - -.swagger-ui .opblock-description-wrapper p, .swagger-ui .opblock-title_normal p { - font-size: 14px; - margin: 0; - font-family: Open Sans, sans-serif; - color: #3b4151 -} - -.swagger-ui .execute-wrapper { - padding: 20px; - text-align: right -} - -.swagger-ui .execute-wrapper .btn { - width: 100%; - padding: 8px 40px -} - -.swagger-ui .body-param-options { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - -webkit-box-orient: vertical; - -webkit-box-direction: normal; - -ms-flex-direction: column; - flex-direction: column -} - -.swagger-ui .body-param-options .body-param-edit { - padding: 10px 0 -} - -.swagger-ui .body-param-options label { - padding: 8px 0 -} - -.swagger-ui .body-param-options label select { - margin: 3px 0 0 -} - -.swagger-ui .responses-inner { - padding: 20px -} - -.swagger-ui .responses-inner h4, .swagger-ui .responses-inner h5 { - font-size: 12px; - margin: 10px 0 5px; - font-family: Open Sans, sans-serif; - color: #3b4151 -} - -.swagger-ui .response-col_status { - font-size: 14px; - font-family: Open Sans, sans-serif; - color: #3b4151 -} - -.swagger-ui .response-col_status .response-undocumented { - font-size: 11px; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #999 -} - -.swagger-ui .response-col_description__inner span { - font-size: 12px; - font-style: italic; - display: block; - margin: 10px 0; - padding: 10px; - border-radius: 4px; - background: #41444e; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #fff -} - -.swagger-ui .response-col_description__inner span p { - margin: 0 -} - -.swagger-ui .opblock-body pre { - font-size: 12px; - margin: 0; - padding: 10px; - white-space: pre-wrap; - border-radius: 4px; - background: #41444e; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #fff -} - -.swagger-ui .opblock-body pre span { - color: #fff!important -} - -.swagger-ui .scheme-container { - margin: 0 0 20px; - padding: 30px 0; - background: #fff; - box-shadow: 0 1px 2px 0 rgba(0, 0, 0, .15) -} - -.swagger-ui .scheme-container .schemes { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center -} - -.swagger-ui .scheme-container .schemes>label { - font-size: 12px; - font-weight: 700; - display: -webkit-box; - display: -ms-flexbox; - display: flex; - -webkit-box-orient: vertical; - -webkit-box-direction: normal; - -ms-flex-direction: column; - flex-direction: column; - margin: -20px 15px 0 0; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui .scheme-container .schemes>label select { - min-width: 130px; - text-transform: uppercase -} - -.swagger-ui .loading-container { - padding: 40px 0 60px -} - -.swagger-ui .loading-container .loading { - position: relative -} - -.swagger-ui .loading-container .loading:after { - font-size: 10px; - font-weight: 700; - position: absolute; - top: 50%; - left: 50%; - content: "loading"; - -webkit-transform: translate(-50%, -50%); - transform: translate(-50%, -50%); - text-transform: uppercase; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui .loading-container .loading:before { - position: absolute; - top: 50%; - left: 50%; - display: block; - width: 60px; - height: 60px; - margin: -30px; - content: ""; - -webkit-animation: rotation 1s infinite linear, opacity .5s; - animation: rotation 1s infinite linear, opacity .5s; - opacity: 1; - border: 2px solid rgba(85, 85, 85, .1); - border-top-color: rgba(0, 0, 0, .6); - border-radius: 100%; - -webkit-backface-visibility: hidden; - backface-visibility: hidden -} - -@-webkit-keyframes rotation { - to { - -webkit-transform: rotate(1turn); - transform: rotate(1turn) - } -} - -@keyframes rotation { - to { - -webkit-transform: rotate(1turn); - transform: rotate(1turn) - } -} - -@-webkit-keyframes blinker { - 50% { - opacity: 0 - } -} - -@keyframes blinker { - 50% { - opacity: 0 - } -} - -.swagger-ui .btn { - font-size: 14px; - font-weight: 700; - padding: 5px 23px; - -webkit-transition: all .3s; - transition: all .3s; - border: 2px solid #888; - border-radius: 4px; - background: transparent; - box-shadow: 0 1px 2px rgba(0, 0, 0, .1); - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui .btn[disabled] { - cursor: not-allowed; - opacity: .3 -} - -.swagger-ui .btn:hover { - box-shadow: 0 0 5px rgba(0, 0, 0, .3) -} - -.swagger-ui .btn.cancel { - border-color: #ff6060; - font-family: Titillium Web, sans-serif; - color: #ff6060 -} - -.swagger-ui .btn.authorize { - line-height: 1; - display: inline; - color: #49cc90; - border-color: #49cc90 -} - -.swagger-ui .btn.authorize span { - float: left; - padding: 4px 20px 0 0 -} - -.swagger-ui .btn.authorize svg { - fill: #49cc90 -} - -.swagger-ui .btn.execute { - -webkit-animation: pulse 2s infinite; - animation: pulse 2s infinite; - color: #fff; - border-color: #4990e2 -} - -@-webkit-keyframes pulse { - 0% { - color: #fff; - background: #4990e2; - box-shadow: 0 0 0 0 rgba(73, 144, 226, .8) - } - 70% { - box-shadow: 0 0 0 5px rgba(73, 144, 226, 0) - } - to { - color: #fff; - background: #4990e2; - box-shadow: 0 0 0 0 rgba(73, 144, 226, 0) - } -} - -@keyframes pulse { - 0% { - color: #fff; - background: #4990e2; - box-shadow: 0 0 0 0 rgba(73, 144, 226, .8) - } - 70% { - box-shadow: 0 0 0 5px rgba(73, 144, 226, 0) - } - to { - color: #fff; - background: #4990e2; - box-shadow: 0 0 0 0 rgba(73, 144, 226, 0) - } -} - -.swagger-ui .btn-group { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - padding: 30px -} - -.swagger-ui .btn-group .btn { - -webkit-box-flex: 1; - -ms-flex: 1; - flex: 1 -} - -.swagger-ui .btn-group .btn:first-child { - border-radius: 4px 0 0 4px -} - -.swagger-ui .btn-group .btn:last-child { - border-radius: 0 4px 4px 0 -} - -.swagger-ui .authorization__btn { - padding: 0 10px; - border: none; - background: none -} - -.swagger-ui .authorization__btn.locked { - opacity: 1 -} - -.swagger-ui .authorization__btn.unlocked { - opacity: .4 -} - -.swagger-ui .expand-methods, .swagger-ui .expand-operation { - border: none; - background: none -} - -.swagger-ui .expand-methods svg, .swagger-ui .expand-operation svg { - width: 20px; - height: 20px -} - -.swagger-ui .expand-methods { - padding: 0 10px -} - -.swagger-ui .expand-methods:hover svg { - fill: #444 -} - -.swagger-ui .expand-methods svg { - -webkit-transition: all .3s; - transition: all .3s; - fill: #777 -} - -.swagger-ui button { - cursor: pointer; - outline: none -} - -.swagger-ui select { - font-size: 14px; - font-weight: 700; - padding: 5px 40px 5px 10px; - border: 2px solid #41444e; - border-radius: 4px; - background: #f7f7f7 url(data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyMCAyMCI+ICAgIDxwYXRoIGQ9Ik0xMy40MTggNy44NTljLjI3MS0uMjY4LjcwOS0uMjY4Ljk3OCAwIC4yNy4yNjguMjcyLjcwMSAwIC45NjlsLTMuOTA4IDMuODNjLS4yNy4yNjgtLjcwNy4yNjgtLjk3OSAwbC0zLjkwOC0zLjgzYy0uMjctLjI2Ny0uMjctLjcwMSAwLS45NjkuMjcxLS4yNjguNzA5LS4yNjguOTc4IDBMMTAgMTFsMy40MTgtMy4xNDF6Ii8+PC9zdmc+) right 10px center no-repeat; - background-size: 20px; - box-shadow: 0 1px 2px 0 rgba(0, 0, 0, .25); - font-family: Titillium Web, sans-serif; - color: #3b4151; - -webkit-appearance: none; - -moz-appearance: none; - appearance: none -} - -.swagger-ui select[multiple] { - margin: 5px 0; - padding: 5px; - background: #f7f7f7 -} - -.swagger-ui .opblock-body select { - min-width: 230px -} - -.swagger-ui label { - font-size: 12px; - font-weight: 700; - margin: 0 0 5px; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui input[type=email], .swagger-ui input[type=password], .swagger-ui input[type=search], .swagger-ui input[type=text] { - min-width: 100px; - margin: 5px 0; - padding: 8px 10px; - border: 1px solid #d9d9d9; - border-radius: 4px; - background: #fff -} - -.swagger-ui input[type=email].invalid, .swagger-ui input[type=password].invalid, .swagger-ui input[type=search].invalid, .swagger-ui input[type=text].invalid { - -webkit-animation: shake .4s 1; - animation: shake .4s 1; - border-color: #f93e3e; - background: #feebeb -} - -@-webkit-keyframes shake { - 10%, 90% { - -webkit-transform: translate3d(-1px, 0, 0); - transform: translate3d(-1px, 0, 0) - } - 20%, 80% { - -webkit-transform: translate3d(2px, 0, 0); - transform: translate3d(2px, 0, 0) - } - 30%, 50%, 70% { - -webkit-transform: translate3d(-4px, 0, 0); - transform: translate3d(-4px, 0, 0) - } - 40%, 60% { - -webkit-transform: translate3d(4px, 0, 0); - transform: translate3d(4px, 0, 0) - } -} - -@keyframes shake { - 10%, 90% { - -webkit-transform: translate3d(-1px, 0, 0); - transform: translate3d(-1px, 0, 0) - } - 20%, 80% { - -webkit-transform: translate3d(2px, 0, 0); - transform: translate3d(2px, 0, 0) - } - 30%, 50%, 70% { - -webkit-transform: translate3d(-4px, 0, 0); - transform: translate3d(-4px, 0, 0) - } - 40%, 60% { - -webkit-transform: translate3d(4px, 0, 0); - transform: translate3d(4px, 0, 0) - } -} - -.swagger-ui textarea { - font-size: 12px; - width: 100%; - min-height: 280px; - padding: 10px; - border: none; - border-radius: 4px; - outline: none; - background: hsla(0, 0%, 100%, .8); - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #3b4151 -} - -.swagger-ui textarea:focus { - border: 2px solid #61affe -} - -.swagger-ui textarea.curl { - font-size: 12px; - min-height: 100px; - margin: 0; - padding: 10px; - resize: none; - border-radius: 4px; - background: #41444e; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #fff -} - -.swagger-ui .checkbox { - padding: 5px 0 10px; - -webkit-transition: opacity .5s; - transition: opacity .5s; - color: #333 -} - -.swagger-ui .checkbox label { - display: -webkit-box; - display: -ms-flexbox; - display: flex -} - -.swagger-ui .checkbox p { - font-weight: 400!important; - font-style: italic; - margin: 0!important; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #3b4151 -} - -.swagger-ui .checkbox input[type=checkbox] { - display: none -} - -.swagger-ui .checkbox input[type=checkbox]+label>.item { - position: relative; - top: 3px; - display: inline-block; - width: 16px; - height: 16px; - margin: 0 8px 0 0; - padding: 5px; - cursor: pointer; - border-radius: 1px; - background: #e8e8e8; - box-shadow: 0 0 0 2px #e8e8e8; - -webkit-box-flex: 0; - -ms-flex: none; - flex: none -} - -.swagger-ui .checkbox input[type=checkbox]+label>.item:active { - -webkit-transform: scale(.9); - transform: scale(.9) -} - -.swagger-ui .checkbox input[type=checkbox]:checked+label>.item { - background: #e8e8e8 url("data:image/svg+xml;charset=utf-8,%3Csvg width='10' height='8' viewBox='3 7 10 8' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill='%2341474E' fill-rule='evenodd' d='M6.333 15L3 11.667l1.333-1.334 2 2L11.667 7 13 8.333z'/%3E%3C/svg%3E") 50% no-repeat -} - -.swagger-ui .dialog-ux { - position: fixed; - z-index: 9999; - top: 0; - right: 0; - bottom: 0; - left: 0 -} - -.swagger-ui .dialog-ux .backdrop-ux { - position: fixed; - top: 0; - right: 0; - bottom: 0; - left: 0; - background: rgba(0, 0, 0, .8) -} - -.swagger-ui .dialog-ux .modal-ux { - position: absolute; - z-index: 9999; - top: 50%; - left: 50%; - width: 100%; - min-width: 300px; - max-width: 650px; - -webkit-transform: translate(-50%, -50%); - transform: translate(-50%, -50%); - border: 1px solid #ebebeb; - border-radius: 4px; - background: #fff; - box-shadow: 0 10px 30px 0 rgba(0, 0, 0, .2) -} - -.swagger-ui .dialog-ux .modal-ux-content { - overflow-y: auto; - max-height: 540px; - padding: 20px -} - -.swagger-ui .dialog-ux .modal-ux-content p { - font-size: 12px; - margin: 0 0 5px; - color: #41444e; - font-family: Open Sans, sans-serif; - color: #3b4151 -} - -.swagger-ui .dialog-ux .modal-ux-content h4 { - font-size: 18px; - font-weight: 600; - margin: 15px 0 0; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui .dialog-ux .modal-ux-header { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - padding: 12px 0; - border-bottom: 1px solid #ebebeb; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center -} - -.swagger-ui .dialog-ux .modal-ux-header .close-modal { - padding: 0 10px; - border: none; - background: none; - -webkit-appearance: none; - -moz-appearance: none; - appearance: none -} - -.swagger-ui .dialog-ux .modal-ux-header h3 { - font-size: 20px; - font-weight: 600; - margin: 0; - padding: 0 20px; - -webkit-box-flex: 1; - -ms-flex: 1; - flex: 1; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui .model { - font-size: 12px; - font-weight: 300; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #3b4151 -} - -.swagger-ui .model-toggle { - font-size: 10px; - position: relative; - top: 6px; - display: inline-block; - margin: auto .3em; - cursor: pointer; - -webkit-transition: -webkit-transform .15s ease-in; - transition: -webkit-transform .15s ease-in; - transition: transform .15s ease-in; - transition: transform .15s ease-in, -webkit-transform .15s ease-in; - -webkit-transform: rotate(90deg); - transform: rotate(90deg); - -webkit-transform-origin: 50% 50%; - transform-origin: 50% 50% -} - -.swagger-ui .model-toggle.collapsed { - -webkit-transform: rotate(0deg); - transform: rotate(0deg) -} - -.swagger-ui .model-toggle:after { - display: block; - width: 20px; - height: 20px; - content: ""; - background: url("data:image/svg+xml;charset=utf-8,%3Csvg xmlns='http://www.w3.org/2000/svg' width='24' height='24' viewBox='0 0 24 24'%3E%3Cpath d='M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z'/%3E%3C/svg%3E") 50% no-repeat; - background-size: 100% -} - -.swagger-ui .model-jump-to-path { - position: relative; - cursor: pointer -} - -.swagger-ui .model-jump-to-path .view-line-link { - position: absolute; - top: -.4em; - cursor: pointer -} - -.swagger-ui .model-title { - position: relative -} - -.swagger-ui .model-title:hover .model-hint { - visibility: visible -} - -.swagger-ui .model-hint { - position: absolute; - top: -1.8em; - visibility: hidden; - padding: .1em .5em; - white-space: nowrap; - color: #ebebeb; - border-radius: 4px; - background: rgba(0, 0, 0, .7) -} - -.swagger-ui section.models { - margin: 30px 0; - border: 1px solid rgba(59, 65, 81, .3); - border-radius: 4px -} - -.swagger-ui section.models.is-open { - padding: 0 0 20px -} - -.swagger-ui section.models.is-open h4 { - margin: 0 0 5px; - border-bottom: 1px solid rgba(59, 65, 81, .3) -} - -.swagger-ui section.models.is-open h4 svg { - -webkit-transform: rotate(90deg); - transform: rotate(90deg) -} - -.swagger-ui section.models h4 { - font-size: 16px; - display: -webkit-box; - display: -ms-flexbox; - display: flex; - margin: 0; - padding: 10px 20px 10px 10px; - cursor: pointer; - -webkit-transition: all .2s; - transition: all .2s; - font-family: Titillium Web, sans-serif; - color: #777; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center -} - -.swagger-ui section.models h4 svg { - -webkit-transition: all .4s; - transition: all .4s -} - -.swagger-ui section.models h4 span { - -webkit-box-flex: 1; - -ms-flex: 1; - flex: 1 -} - -.swagger-ui section.models h4:hover { - background: rgba(0, 0, 0, .02) -} - -.swagger-ui section.models h5 { - font-size: 16px; - margin: 0 0 10px; - font-family: Titillium Web, sans-serif; - color: #777 -} - -.swagger-ui section.models .model-jump-to-path { - position: relative; - top: 5px -} - -.swagger-ui section.models .model-container { - margin: 0 20px 15px; - -webkit-transition: all .5s; - transition: all .5s; - border-radius: 4px; - background: rgba(0, 0, 0, .05) -} - -.swagger-ui section.models .model-container:hover { - background: rgba(0, 0, 0, .07) -} - -.swagger-ui section.models .model-container:first-of-type { - margin: 20px -} - -.swagger-ui section.models .model-container:last-of-type { - margin: 0 20px -} - -.swagger-ui section.models .model-box { - background: none -} - -.swagger-ui .model-box { - padding: 10px; - border-radius: 4px; - background: rgba(0, 0, 0, .1) -} - -.swagger-ui .model-box .model-jump-to-path { - position: relative; - top: 4px -} - -.swagger-ui .model-title { - font-size: 16px; - font-family: Titillium Web, sans-serif; - color: #555 -} - -.swagger-ui span>span.model, .swagger-ui span>span.model .brace-close { - padding: 0 0 0 10px -} - -.swagger-ui .prop-type { - color: #55a -} - -.swagger-ui .prop-enum { - display: block -} - -.swagger-ui .prop-format { - color: #999 -} - -.swagger-ui table { - width: 100%; - padding: 0 10px; - border-collapse: collapse -} - -.swagger-ui table.model tbody tr td { - padding: 0; - vertical-align: top -} - -.swagger-ui table.model tbody tr td:first-of-type { - width: 100px; - padding: 0 -} - -.swagger-ui table.headers td { - font-size: 12px; - font-weight: 300; - vertical-align: middle; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #3b4151 -} - -.swagger-ui table tbody tr td { - padding: 10px 0 0; - vertical-align: top -} - -.swagger-ui table tbody tr td:first-of-type { - width: 20%; - padding: 10px 0 -} - -.swagger-ui table thead tr td, .swagger-ui table thead tr th { - font-size: 12px; - font-weight: 700; - padding: 12px 0; - text-align: left; - border-bottom: 1px solid rgba(59, 65, 81, .2); - font-family: Open Sans, sans-serif; - color: #3b4151 -} - -.swagger-ui .parameters-col_description p { - font-size: 14px; - margin: 0; - font-family: Open Sans, sans-serif; - color: #3b4151 -} - -.swagger-ui .parameters-col_description input[type=text] { - width: 100%; - max-width: 340px -} - -.swagger-ui .parameter__name { - font-size: 16px; - font-weight: 400; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui .parameter__name.required { - font-weight: 700 -} - -.swagger-ui .parameter__name.required:after { - font-size: 10px; - position: relative; - top: -6px; - padding: 5px; - content: "required"; - color: rgba(255, 0, 0, .6) -} - -.swagger-ui .parameter__in { - font-size: 12px; - font-style: italic; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #888 -} - -.swagger-ui .table-container { - padding: 20px -} - -.swagger-ui .topbar { - padding: 8px 30px; - background-color: #89bf04 -} - -.swagger-ui .topbar .topbar-wrapper { - -ms-flex-align: center -} - -.swagger-ui .topbar .topbar-wrapper, .swagger-ui .topbar a { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - -webkit-box-align: center; - align-items: center -} - -.swagger-ui .topbar a { - font-size: 1.5em; - font-weight: 700; - text-decoration: none; - -webkit-box-flex: 1; - -ms-flex: 1; - flex: 1; - -ms-flex-align: center; - font-family: Titillium Web, sans-serif; - color: #fff -} - -.swagger-ui .topbar a span { - margin: 0; - padding: 0 10px -} - -.swagger-ui .topbar .download-url-wrapper { - display: -webkit-box; - display: -ms-flexbox; - display: flex -} - -.swagger-ui .topbar .download-url-wrapper input[type=text] { - min-width: 350px; - margin: 0; - border: 2px solid #547f00; - border-radius: 4px 0 0 4px; - outline: none -} - -.swagger-ui .topbar .download-url-wrapper .download-url-button { - font-size: 16px; - font-weight: 700; - padding: 4px 40px; - border: none; - border-radius: 0 4px 4px 0; - background: #547f00; - font-family: Titillium Web, sans-serif; - color: #fff -} - -.swagger-ui .info { - margin: 50px 0 -} - -.swagger-ui .info hgroup.main { - margin: 0 0 20px -} - -.swagger-ui .info hgroup.main a { - font-size: 12px -} - -.swagger-ui .info p { - font-size: 14px; - font-family: Open Sans, sans-serif; - color: #3b4151 -} - -.swagger-ui .info code { - padding: 3px 5px; - border-radius: 4px; - background: rgba(0, 0, 0, .05); - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #9012fe -} - -.swagger-ui .info a { - font-size: 14px; - -webkit-transition: all .4s; - transition: all .4s; - font-family: Open Sans, sans-serif; - color: #4990e2 -} - -.swagger-ui .info a:hover { - color: #1f69c0 -} - -.swagger-ui .info>div { - margin: 0 0 5px -} - -.swagger-ui .info .base-url { - font-size: 12px; - font-weight: 300!important; - margin: 0; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #3b4151 -} - -.swagger-ui .info .title { - font-size: 36px; - margin: 0; - font-family: Open Sans, sans-serif; - color: #3b4151 -} - -.swagger-ui .info .title small { - font-size: 10px; - position: relative; - top: -5px; - display: inline-block; - margin: 0 0 0 5px; - padding: 2px 4px; - vertical-align: super; - border-radius: 57px; - background: #7d8492 -} - -.swagger-ui .info .title small pre { - margin: 0; - font-family: Titillium Web, sans-serif; - color: #fff -} - -.swagger-ui .auth-btn-wrapper { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - padding: 10px 0; - -webkit-box-pack: center; - -ms-flex-pack: center; - justify-content: center -} - -.swagger-ui .auth-wrapper { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - -webkit-box-flex: 1; - -ms-flex: 1; - flex: 1; - -webkit-box-pack: end; - -ms-flex-pack: end; - justify-content: flex-end -} - -.swagger-ui .auth-wrapper .authorize { - padding-right: 20px -} - -.swagger-ui .auth-container { - margin: 0 0 10px; - padding: 10px 20px; - border-bottom: 1px solid #ebebeb -} - -.swagger-ui .auth-container:last-of-type { - margin: 0; - padding: 10px 20px; - border: 0 -} - -.swagger-ui .auth-container h4 { - margin: 5px 0 15px!important -} - -.swagger-ui .auth-container .wrapper { - margin: 0; - padding: 0 -} - -.swagger-ui .auth-container input[type=password], .swagger-ui .auth-container input[type=text] { - min-width: 230px -} - -.swagger-ui .auth-container .errors { - font-size: 12px; - padding: 10px; - border-radius: 4px; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #3b4151 -} - -.swagger-ui .scopes h2 { - font-size: 14px; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -.swagger-ui .scope-def { - padding: 0 0 20px -} - -.swagger-ui .errors-wrapper { - margin: 20px; - padding: 10px 20px; - -webkit-animation: scaleUp .5s; - animation: scaleUp .5s; - border: 2px solid #f93e3e; - border-radius: 4px; - background: rgba(249, 62, 62, .1) -} - -.swagger-ui .errors-wrapper .error-wrapper { - margin: 0 0 10px -} - -.swagger-ui .errors-wrapper .errors h4 { - font-size: 14px; - margin: 0; - font-family: Source Code Pro, monospace; - font-weight: 600; - color: #3b4151 -} - -.swagger-ui .errors-wrapper hgroup { - display: -webkit-box; - display: -ms-flexbox; - display: flex; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center -} - -.swagger-ui .errors-wrapper hgroup h4 { - font-size: 20px; - margin: 0; - -webkit-box-flex: 1; - -ms-flex: 1; - flex: 1; - font-family: Titillium Web, sans-serif; - color: #3b4151 -} - -@-webkit-keyframes scaleUp { - 0% { - -webkit-transform: scale(.8); - transform: scale(.8); - opacity: 0 - } - to { - -webkit-transform: scale(1); - transform: scale(1); - opacity: 1 - } -} - -@keyframes scaleUp { - 0% { - -webkit-transform: scale(.8); - transform: scale(.8); - opacity: 0 - } - to { - -webkit-transform: scale(1); - transform: scale(1); - opacity: 1 - } -} - -.swagger-ui .Resizer.vertical.disabled { - display: none -} - -/*# sourceMappingURL=swagger-ui.css.map*/ - -/** - * Swagger UI Theme Overrides - * - * Theme: Muted - * Author: Mark Ostrander - * Github: https://github.com/ostranme/swagger-ui-themes - */ - - .swagger-ui .opblock.opblock-post { - border-color: #DADFE1; - background: rgba(246, 246, 246, .1); - } - - .swagger-ui .opblock.opblock-post .opblock-summary-method { - background: #64908A; - } - - .swagger-ui .opblock.opblock-post .opblock-summary { - border-color: #DADFE1; - } - - .swagger-ui .opblock.opblock-put { - border-color: #DADFE1; - background: rgba(246, 246, 246, .1); - } - - .swagger-ui .opblock.opblock-put .opblock-summary-method { - background: #633B63; - } - - .swagger-ui .opblock.opblock-put .opblock-summary { - border-color: #DADFE1; - } - - .swagger-ui .opblock.opblock-delete { - border-color: #DADFE1; - background: rgba(246, 246, 246, .1); - } - - .swagger-ui .opblock.opblock-delete .opblock-summary-method { - background: #C1786A; - } - - .swagger-ui .opblock.opblock-delete .opblock-summary { - border-color: #DADFE1; - } - - .swagger-ui .opblock.opblock-get { - border-color: #DADFE1; - background: rgba(246, 246, 246, .1); - } - - .swagger-ui .opblock.opblock-get .opblock-summary-method { - background: #3F778E; - } - - .swagger-ui .opblock.opblock-get .opblock-summary { - border-color: #DADFE1; - } - - .swagger-ui .opblock.opblock-patch { - border-color: #DADFE1; - background: rgba(246, 246, 246, .1); - } - - .swagger-ui .opblock.opblock-patch .opblock-summary-method { - background: #C1976A; - } - - .swagger-ui .opblock.opblock-patch .opblock-summary { - border-color: #DADFE1; - } - - .swagger-ui .opblock.opblock-head { - border-color: #DADFE1; - background: rgba(246, 246, 246, .1); - } - - .swagger-ui .opblock.opblock-head .opblock-summary-method { - background: #C1976A; - } - - .swagger-ui .opblock.opblock-head .opblock-summary { - border-color: #DADFE1; - } - - .swagger-ui .opblock.opblock-options { - border-color: #DADFE1; - background: rgba(246, 246, 246, .1); - } - - .swagger-ui .opblock.opblock-options .opblock-summary-method { - background: #3F778E; - } - - .swagger-ui .opblock.opblock-options .opblock-summary { - border-color: #DADFE1; - } - - .swagger-ui .topbar { - padding: 8px 30px; - background-color: #6F7E88; - } - - .swagger-ui .topbar .download-url-wrapper input[type=text] { - min-width: 350px; - margin: 0; - border: 2px solid #DADFE1; - border-radius: 4px 0 0 4px; - outline: none; - } - - .swagger-ui .topbar .download-url-wrapper .download-url-button { - font-size: 16px; - font-weight: 700; - padding: 4px 40px; - border: none; - border-radius: 0 4px 4px 0; - background: #DADFE1; - font-family: Titillium Web, sans-serif; - color: #6F7E88; - } - - .swagger-ui .info a { - font-size: 14px; - -webkit-transition: all .4s; - transition: all .4s; - font-family: Open Sans, sans-serif; - color: #6F7E88; - } - - .swagger-ui .info a:hover { - color: #6F7E88; - } - - .swagger-ui .btn.authorize { - line-height: 1; - display: inline; - color: #6F7E88; - border-color: #6F7E88; - } - - .swagger-ui .btn.authorize svg { - fill: #6F7E88; - } -© 2019 GitHub, Inc. -Terms -Privacy -Security -Status -Help -Contact GitHub -Pricing -API -Training -Blog -About diff --git a/src/swagger/css/typography.css b/src/swagger/css/typography.css deleted file mode 100755 index 27c3751ac2e..00000000000 --- a/src/swagger/css/typography.css +++ /dev/null @@ -1,26 +0,0 @@ -/* droid-sans-regular - latin */ -@font-face { - font-family: 'Droid Sans'; - font-style: normal; - font-weight: 400; - src: url('../fonts/droid-sans-v6-latin-regular.eot'); /* IE9 Compat Modes */ - src: local('Droid Sans'), local('DroidSans'), - url('../fonts/droid-sans-v6-latin-regular.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */ - url('../fonts/droid-sans-v6-latin-regular.woff2') format('woff2'), /* Super Modern Browsers */ - url('../fonts/droid-sans-v6-latin-regular.woff') format('woff'), /* Modern Browsers */ - url('../fonts/droid-sans-v6-latin-regular.ttf') format('truetype'), /* Safari, Android, iOS */ - url('../fonts/droid-sans-v6-latin-regular.svg#DroidSans') format('svg'); /* Legacy iOS */ -} -/* droid-sans-700 - latin */ -@font-face { - font-family: 'Droid Sans'; - font-style: normal; - font-weight: 700; - src: url('../fonts/droid-sans-v6-latin-700.eot'); /* IE9 Compat Modes */ - src: local('Droid Sans Bold'), local('DroidSans-Bold'), - url('../fonts/droid-sans-v6-latin-700.eot?#iefix') format('embedded-opentype'), /* IE6-IE8 */ - url('../fonts/droid-sans-v6-latin-700.woff2') format('woff2'), /* Super Modern Browsers */ - url('../fonts/droid-sans-v6-latin-700.woff') format('woff'), /* Modern Browsers */ - url('../fonts/droid-sans-v6-latin-700.ttf') format('truetype'), /* Safari, Android, iOS */ - url('../fonts/droid-sans-v6-latin-700.svg#DroidSans') format('svg'); /* Legacy iOS */ -} diff --git a/src/swagger/fonts/droid-sans-v6-latin-700.eot b/src/swagger/fonts/droid-sans-v6-latin-700.eot deleted file mode 100755 index d8524983ad8..00000000000 Binary files a/src/swagger/fonts/droid-sans-v6-latin-700.eot and /dev/null differ diff --git a/src/swagger/fonts/droid-sans-v6-latin-700.svg b/src/swagger/fonts/droid-sans-v6-latin-700.svg deleted file mode 100755 index 15970395a75..00000000000 --- a/src/swagger/fonts/droid-sans-v6-latin-700.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/src/swagger/fonts/droid-sans-v6-latin-700.ttf b/src/swagger/fonts/droid-sans-v6-latin-700.ttf deleted file mode 100755 index 15896c441fd..00000000000 Binary files a/src/swagger/fonts/droid-sans-v6-latin-700.ttf and /dev/null differ diff --git a/src/swagger/fonts/droid-sans-v6-latin-700.woff b/src/swagger/fonts/droid-sans-v6-latin-700.woff deleted file mode 100755 index 67e3e25f836..00000000000 Binary files a/src/swagger/fonts/droid-sans-v6-latin-700.woff and /dev/null differ diff --git a/src/swagger/fonts/droid-sans-v6-latin-700.woff2 b/src/swagger/fonts/droid-sans-v6-latin-700.woff2 deleted file mode 100755 index 1e726a7cfce..00000000000 Binary files a/src/swagger/fonts/droid-sans-v6-latin-700.woff2 and /dev/null differ diff --git a/src/swagger/fonts/droid-sans-v6-latin-regular.eot b/src/swagger/fonts/droid-sans-v6-latin-regular.eot deleted file mode 100755 index ac2698e85ae..00000000000 Binary files a/src/swagger/fonts/droid-sans-v6-latin-regular.eot and /dev/null differ diff --git a/src/swagger/fonts/droid-sans-v6-latin-regular.svg b/src/swagger/fonts/droid-sans-v6-latin-regular.svg deleted file mode 100755 index b7df97e0686..00000000000 --- a/src/swagger/fonts/droid-sans-v6-latin-regular.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/src/swagger/fonts/droid-sans-v6-latin-regular.ttf b/src/swagger/fonts/droid-sans-v6-latin-regular.ttf deleted file mode 100755 index fb8cea662b2..00000000000 Binary files a/src/swagger/fonts/droid-sans-v6-latin-regular.ttf and /dev/null differ diff --git a/src/swagger/fonts/droid-sans-v6-latin-regular.woff b/src/swagger/fonts/droid-sans-v6-latin-regular.woff deleted file mode 100755 index abf19899f75..00000000000 Binary files a/src/swagger/fonts/droid-sans-v6-latin-regular.woff and /dev/null differ diff --git a/src/swagger/fonts/droid-sans-v6-latin-regular.woff2 b/src/swagger/fonts/droid-sans-v6-latin-regular.woff2 deleted file mode 100755 index 9f93f74c3be..00000000000 Binary files a/src/swagger/fonts/droid-sans-v6-latin-regular.woff2 and /dev/null differ diff --git a/src/swagger/images/explorer_icons.png b/src/swagger/images/explorer_icons.png deleted file mode 100644 index 5ab0e0a2edb..00000000000 Binary files a/src/swagger/images/explorer_icons.png and /dev/null differ diff --git a/src/swagger/images/favicon-16x16.png b/src/swagger/images/favicon-16x16.png deleted file mode 100755 index 66b1a5bfb9e..00000000000 Binary files a/src/swagger/images/favicon-16x16.png and /dev/null differ diff --git a/src/swagger/images/favicon-32x32.png b/src/swagger/images/favicon-32x32.png deleted file mode 100644 index cb8ff4b40f4..00000000000 Binary files a/src/swagger/images/favicon-32x32.png and /dev/null differ diff --git a/src/swagger/images/favicon.ico b/src/swagger/images/favicon.ico deleted file mode 100755 index 8b60bcf06a7..00000000000 Binary files a/src/swagger/images/favicon.ico and /dev/null differ diff --git a/src/swagger/images/logo_small.png b/src/swagger/images/logo_small.png deleted file mode 100644 index d2c6c640405..00000000000 Binary files a/src/swagger/images/logo_small.png and /dev/null differ diff --git a/src/swagger/images/magento_32.png b/src/swagger/images/magento_32.png deleted file mode 100644 index fc0991e29e8..00000000000 Binary files a/src/swagger/images/magento_32.png and /dev/null differ diff --git a/src/swagger/images/throbber.gif b/src/swagger/images/throbber.gif deleted file mode 100755 index 0a55cf035e3..00000000000 Binary files a/src/swagger/images/throbber.gif and /dev/null differ diff --git a/src/swagger/images/wordnik_api.png b/src/swagger/images/wordnik_api.png deleted file mode 100755 index dca4f1455ac..00000000000 Binary files a/src/swagger/images/wordnik_api.png and /dev/null differ diff --git a/src/swagger/index.html b/src/swagger/index.html deleted file mode 100644 index 50fb9c1cfe6..00000000000 --- a/src/swagger/index.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - - Magento REST API documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Magento Commerce for B2B v2.2

-
- - diff --git a/src/swagger/index_22.html b/src/swagger/index_22.html deleted file mode 100644 index 4feb45b1608..00000000000 --- a/src/swagger/index_22.html +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Magento REST API documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - diff --git a/src/swagger/index_23.html b/src/swagger/index_23.html deleted file mode 100644 index 6ccbcbef081..00000000000 --- a/src/swagger/index_23.html +++ /dev/null @@ -1,81 +0,0 @@ - - - - - Magento REST API documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - diff --git a/src/swagger/o2c.html b/src/swagger/o2c.html deleted file mode 100755 index 88e8bf114b1..00000000000 --- a/src/swagger/o2c.html +++ /dev/null @@ -1,20 +0,0 @@ - \ No newline at end of file diff --git a/src/swagger/schemas/2.0.0-rc-api-schema.json b/src/swagger/schemas/2.0.0-rc-api-schema.json deleted file mode 100644 index 7bbf7440054..00000000000 --- a/src/swagger/schemas/2.0.0-rc-api-schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.0","title":"Magento Community Edition"},"host":"m2.com","basePath":"/rest","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":""},{"name":"searchV1","description":"Search API for all requests"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customer.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{id}":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customer.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","parameters":[{"name":"$body","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save custom option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save custom option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-estimate-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteGuestShippingMethodManagementV1EstimateByAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-estimate-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"$body","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"websiteId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"websiteId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"websiteId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve coupon.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"$body","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"$body","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"$body","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"websiteId":{"type":"integer"},"storeGroupId":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","websiteId","storeGroupId"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"websiteId":{"type":"integer"},"rootCategoryId":{"type":"integer"},"defaultStoreId":{"type":"integer"},"name":{"type":"string"},"extensionAttributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","websiteId","rootCategoryId","defaultStoreId","name"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"defaultGroupId":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","defaultGroupId"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"websiteId":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"defaultDisplayCurrencyCode":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weightUnit":{"type":"string","description":"The unit of weight"},"baseUrl":{"type":"string","description":"Base URL for the store"},"baseLinkUrl":{"type":"string","description":"Base link URL for the store"},"baseStaticUrl":{"type":"string","description":"Base static URL for the store"},"baseMediaUrl":{"type":"string","description":"Base media URL for the store"},"secureBaseUrl":{"type":"string","description":"Secure base URL for the store"},"secureBaseLinkUrl":{"type":"string","description":"Secure base link URL for the store"},"secureBaseStaticUrl":{"type":"string","description":"Secure base static URL for the store"},"secureBaseMediaUrl":{"type":"string","description":"Secure base media URL for the store"},"extensionAttributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","websiteId","locale","baseCurrencyCode","defaultDisplayCurrencyCode","timezone","weightUnit","baseUrl","baseLinkUrl","baseStaticUrl","baseMediaUrl","secureBaseUrl","secureBaseLinkUrl","secureBaseStaticUrl","secureBaseMediaUrl"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"baseCurrencyCode":{"type":"string","description":"The base currency code for the store."},"baseCurrencySymbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"defaultDisplayCurrencyCode":{"type":"string","description":"The default display currency code for the store."},"defaultDisplayCurrencySymbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"availableCurrencyCodes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchangeRates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extensionAttributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["baseCurrencyCode","baseCurrencySymbol","defaultDisplayCurrencyCode","defaultDisplayCurrencySymbol","availableCurrencyCodes","exchangeRates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currencyTo":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extensionAttributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currencyTo","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"twoLetterAbbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"threeLetterAbbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"fullNameLocale":{"type":"string","description":"The country full name (in store locale) for the store."},"fullNameEnglish":{"type":"string","description":"The country full name (in English) for the store."},"availableRegions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extensionAttributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","twoLetterAbbreviation","threeLetterAbbreviation","fullNameLocale","fullNameEnglish"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extensionAttributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"eav-data-attribute-set-interface":{"type":"object","description":"","properties":{"attributeSetId":{"type":"integer","description":"Attribute set ID"},"attributeSetName":{"type":"string","description":"Attribute set name"},"sortOrder":{"type":"integer","description":"Attribute set sort order index"},"entityTypeId":{"type":"integer","description":"Attribute set entity type id"},"extensionAttributes":{"$ref":"#/definitions/eav-data-attribute-set-extension-interface"}},"required":["attributeSetName","sortOrder"]},"eav-data-attribute-set-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Eav\\Api\\Data\\AttributeSetInterface"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filterGroups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sortOrders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"pageSize":{"type":"integer","description":"Page size."},"currentPage":{"type":"integer","description":"Current page."}},"required":["filterGroups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"conditionType":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"customer-data-group-interface":{"type":"object","description":"Customer group interface.","properties":{"id":{"type":"integer","description":"Id"},"code":{"type":"string","description":"Code"},"taxClassId":{"type":"integer","description":"Tax class id"},"taxClassName":{"type":"string","description":"Tax class name"},"extensionAttributes":{"$ref":"#/definitions/customer-data-group-extension-interface"}},"required":["code","taxClassId"]},"customer-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\GroupInterface"},"customer-data-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontendInput":{"type":"string","description":"HTML for input element."},"inputFilter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"storeLabel":{"type":"string","description":"Label of the store."},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multilineCount":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"dataModel":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontendClass":{"type":"string","description":"Class which is used to display the attribute on frontend."},"userDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sortOrder":{"type":"integer","description":"Attributes sort order."},"frontendLabel":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backendType":{"type":"string","description":"Backend type."},"isUsedInGrid":{"type":"boolean","description":"It is used in customer grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in customer grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in customer grid"},"isSearchableInGrid":{"type":"boolean","description":"It is searchable in customer grid"},"attributeCode":{"type":"string","description":"Code of the attribute."}},"required":["frontendInput","inputFilter","storeLabel","validationRules","multilineCount","visible","required","dataModel","options","frontendClass","userDefined","sortOrder","frontendLabel","note","system","backendType","attributeCode"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"customer-data-customer-interface":{"type":"object","description":"Customer interface.","properties":{"id":{"type":"integer","description":"Customer id"},"groupId":{"type":"integer","description":"Group id"},"defaultBilling":{"type":"string","description":"Default billing address id"},"defaultShipping":{"type":"string","description":"Default shipping address id"},"confirmation":{"type":"string","description":"Confirmation"},"createdAt":{"type":"string","description":"Created at time"},"updatedAt":{"type":"string","description":"Updated at time"},"createdIn":{"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"},"storeId":{"type":"integer","description":"Store id"},"taxvat":{"type":"string","description":"Tax Vat"},"websiteId":{"type":"integer","description":"Website id"},"addresses":{"type":"array","description":"Customer addresses.","items":{"$ref":"#/definitions/customer-data-address-interface"}},"disableAutoGroupChange":{"type":"integer","description":"Disable auto group change flag."},"extensionAttributes":{"$ref":"#/definitions/customer-data-customer-extension-interface"},"customAttributes":{"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"},"customerId":{"type":"integer","description":"Customer ID"},"region":{"$ref":"#/definitions/customer-data-region-interface"},"regionId":{"type":"integer","description":"Region ID"},"countryId":{"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"},"vatId":{"type":"string","description":"Vat id"},"defaultShipping":{"type":"boolean","description":"If this address is default shipping address."},"defaultBilling":{"type":"boolean","description":"If this address is default billing address"},"extensionAttributes":{"$ref":"#/definitions/customer-data-address-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"customer-data-region-interface":{"type":"object","description":"Customer address region interface.","properties":{"regionCode":{"type":"string","description":"Region code"},"region":{"type":"string","description":"Region"},"regionId":{"type":"integer","description":"Region id"},"extensionAttributes":{"$ref":"#/definitions/customer-data-region-extension-interface"}},"required":["regionCode","region","regionId"]},"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":{"attributeCode":{"type":"string","description":"Attribute code"},"value":{"type":"string","description":"Attribute value"}},"required":["attributeCode","value"]},"customer-data-customer-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\CustomerInterface"},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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"},"pageLayout":{"type":"string","description":"Page layout"},"metaKeywords":{"type":"string","description":"Meta keywords"},"metaDescription":{"type":"string","description":"Meta description"},"contentHeading":{"type":"string","description":"Content heading"},"content":{"type":"string","description":"Content"},"creationTime":{"type":"string","description":"Creation time"},"updateTime":{"type":"string","description":"Update time"},"sortOrder":{"type":"string","description":"Sort order"},"layoutUpdateXml":{"type":"string","description":"Layout update xml"},"customTheme":{"type":"string","description":"Custom theme"},"customRootTemplate":{"type":"string","description":"Custom root template"},"customLayoutUpdateXml":{"type":"string","description":"Custom layout update xml"},"customThemeFrom":{"type":"string","description":"Custom theme from"},"customThemeTo":{"type":"string","description":"Custom theme to"},"active":{"type":"boolean","description":"Active"}},"required":["identifier"]},"cms-data-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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"},"creationTime":{"type":"string","description":"Creation time"},"updateTime":{"type":"string","description":"Update time"},"active":{"type":"boolean","description":"Active"}},"required":["identifier"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Id"},"sku":{"type":"string","description":"Sku"},"name":{"type":"string","description":"Name"},"storeId":{"type":"integer","description":"Store id"},"attributeSetId":{"type":"integer","description":"Attribute set id"},"price":{"type":"number","description":"Price"},"status":{"type":"integer","description":"Status"},"visibility":{"type":"integer","description":"Visibility"},"typeId":{"type":"string","description":"Type id"},"createdAt":{"type":"string","description":"Created date"},"updatedAt":{"type":"string","description":"Updated date"},"weight":{"type":"number","description":"Weight"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-extension-interface"},"productLinks":{"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"}},"mediaGalleryEntries":{"type":"array","description":"Media gallery entries","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"tierPrices":{"type":"array","description":"List of product tier prices","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}},"customAttributes":{"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":{"bundleProductOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}},"downloadableProductLinks":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}},"downloadableProductSamples":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}},"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"configurableProductOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"configurableProductLinks":{"type":"array","items":{"type":"integer"}}}},"bundle-data-option-interface":{"type":"object","description":"Interface OptionInterface","properties":{"optionId":{"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"},"productLinks":{"type":"array","description":"Product links","items":{"$ref":"#/definitions/bundle-data-link-interface"}},"extensionAttributes":{"$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"},"optionId":{"type":"integer","description":"Option id"},"qty":{"type":"number","description":"Qty"},"position":{"type":"integer","description":"Position"},"isDefault":{"type":"boolean","description":"Is default"},"price":{"type":"number","description":"Price"},"priceType":{"type":"integer","description":"Price type"},"canChangeQuantity":{"type":"integer","description":"Whether quantity could be changed"},"extensionAttributes":{"$ref":"#/definitions/bundle-data-link-extension-interface"}},"required":["isDefault","price","priceType"]},"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"},"downloadable-data-link-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Sample(or link) id"},"title":{"type":"string"},"sortOrder":{"type":"integer"},"isShareable":{"type":"integer","description":"Shareable status"},"price":{"type":"number","description":"Price"},"numberOfDownloads":{"type":"integer","description":"Of downloads per user"},"linkType":{"type":"string"},"linkFile":{"type":"string","description":"relative file path"},"linkFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"linkUrl":{"type":"string","description":"Link url or null when type is 'file'"},"sampleType":{"type":"string"},"sampleFile":{"type":"string","description":"relative file path"},"sampleFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"sampleUrl":{"type":"string","description":"file URL"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-link-extension-interface"}},"required":["sortOrder","isShareable","price","linkType","sampleType"]},"downloadable-data-file-content-interface":{"type":"object","description":"","properties":{"fileData":{"type":"string","description":"Data (base64 encoded content)"},"name":{"type":"string","description":"File name"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-file-content-extension-interface"}},"required":["fileData","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"},"sortOrder":{"type":"integer","description":"Order index for sample"},"sampleType":{"type":"string"},"sampleFile":{"type":"string","description":"relative file path"},"sampleFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"sampleUrl":{"type":"string","description":"file URL"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-sample-extension-interface"}},"required":["title","sortOrder","sampleType"]},"downloadable-data-sample-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Downloadable\\Api\\Data\\SampleInterface"},"catalog-inventory-data-stock-item-interface":{"type":"object","description":"Interface StockItem","properties":{"itemId":{"type":"integer"},"productId":{"type":"integer"},"websiteId":{"type":"integer","description":"Website Id"},"stockId":{"type":"integer","description":"Stock identifier"},"qty":{"type":"number"},"isInStock":{"type":"boolean","description":"Stock Availability"},"isQtyDecimal":{"type":"boolean"},"showDefaultNotificationMessage":{"type":"boolean"},"useConfigMinQty":{"type":"boolean"},"minQty":{"type":"number","description":"Minimal quantity available for item status in stock"},"useConfigMinSaleQty":{"type":"integer"},"minSaleQty":{"type":"number","description":"Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation"},"useConfigMaxSaleQty":{"type":"boolean"},"maxSaleQty":{"type":"number","description":"Maximum Qty Allowed in Shopping Cart data wrapper"},"useConfigBackorders":{"type":"boolean"},"backorders":{"type":"integer","description":"Backorders status"},"useConfigNotifyStockQty":{"type":"boolean"},"notifyStockQty":{"type":"number","description":"Notify for Quantity Below data wrapper"},"useConfigQtyIncrements":{"type":"boolean"},"qtyIncrements":{"type":"number","description":"Quantity Increments data wrapper"},"useConfigEnableQtyInc":{"type":"boolean"},"enableQtyIncrements":{"type":"boolean","description":"Whether Quantity Increments is enabled"},"useConfigManageStock":{"type":"boolean"},"manageStock":{"type":"boolean","description":"Can Manage Stock"},"lowStockDate":{"type":"string"},"isDecimalDivided":{"type":"boolean"},"stockStatusChangedAuto":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/catalog-inventory-data-stock-item-extension-interface"}},"required":["qty","isInStock","isQtyDecimal","showDefaultNotificationMessage","useConfigMinQty","minQty","useConfigMinSaleQty","minSaleQty","useConfigMaxSaleQty","maxSaleQty","useConfigBackorders","backorders","useConfigNotifyStockQty","notifyStockQty","useConfigQtyIncrements","qtyIncrements","useConfigEnableQtyInc","enableQtyIncrements","useConfigManageStock","manageStock","lowStockDate","isDecimalDivided","stockStatusChangedAuto"]},"catalog-inventory-data-stock-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockItemInterface"},"configurable-product-data-option-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"attributeId":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"},"isUseDefault":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-value-interface"}},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-option-extension-interface"},"productId":{"type":"integer"}}},"configurable-product-data-option-value-interface":{"type":"object","description":"","properties":{"valueIndex":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-option-value-extension-interface"}},"required":["valueIndex"]},"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"},"catalog-data-product-link-interface":{"type":"object","description":"","properties":{"sku":{"type":"string","description":"SKU"},"linkType":{"type":"string","description":"Link type"},"linkedProductSku":{"type":"string","description":"Linked product sku"},"linkedProductType":{"type":"string","description":"Linked product type (simple, virtual, etc)"},"position":{"type":"integer","description":"Linked item position"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-extension-interface"}},"required":["sku","linkType","linkedProductSku","linkedProductType","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":{"productSku":{"type":"string","description":"Product SKU"},"optionId":{"type":"integer","description":"Option id"},"title":{"type":"string","description":"Option title"},"type":{"type":"string","description":"Option type"},"sortOrder":{"type":"integer","description":"Sort order"},"isRequire":{"type":"boolean","description":"Is require"},"price":{"type":"number","description":"Price"},"priceType":{"type":"string","description":"Price type"},"sku":{"type":"string","description":"Sku"},"fileExtension":{"type":"string"},"maxCharacters":{"type":"integer"},"imageSizeX":{"type":"integer"},"imageSizeY":{"type":"integer"},"values":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-values-interface"}},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-custom-option-extension-interface"}},"required":["productSku","title","type","sortOrder","isRequire"]},"catalog-data-product-custom-option-values-interface":{"type":"object","description":"","properties":{"title":{"type":"string","description":"Option title"},"sortOrder":{"type":"integer","description":"Sort order"},"price":{"type":"number","description":"Price"},"priceType":{"type":"string","description":"Price type"},"sku":{"type":"string","description":"Sku"},"optionTypeId":{"type":"integer","description":"Option type id"}},"required":["title","sortOrder","price","priceType"]},"catalog-data-product-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionInterface"},"catalog-data-product-attribute-media-gallery-entry-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Gallery entry ID"},"mediaType":{"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"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-extension-interface"}},"required":["mediaType","label","position","disabled","types"]},"framework-data-image-content-interface":{"type":"object","description":"Image Content data interface","properties":{"base64EncodedData":{"type":"string","description":"Media data (base64 encoded content)"},"type":{"type":"string","description":"MIME type"},"name":{"type":"string","description":"Image name"}},"required":["base64EncodedData","type","name"]},"catalog-data-product-attribute-media-gallery-entry-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeMediaGalleryEntryInterface","properties":{"videoContent":{"$ref":"#/definitions/framework-data-video-content-interface"}}},"framework-data-video-content-interface":{"type":"object","description":"Video Content data interface","properties":{"mediaType":{"type":"string","description":"MIME type"},"videoProvider":{"type":"string","description":"Provider"},"videoUrl":{"type":"string","description":"Video URL"},"videoTitle":{"type":"string","description":"Title"},"videoDescription":{"type":"string","description":"Video Description"},"videoMetadata":{"type":"string","description":"Metadata"}},"required":["mediaType","videoProvider","videoUrl","videoTitle","videoDescription","videoMetadata"]},"catalog-data-product-tier-price-interface":{"type":"object","description":"","properties":{"customerGroupId":{"type":"integer","description":"Customer group id"},"qty":{"type":"number","description":"Tier qty"},"value":{"type":"number","description":"Price value"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-tier-price-extension-interface"}},"required":["customerGroupId","qty","value"]},"catalog-data-product-tier-price-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTierPriceInterface"},"catalog-data-product-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"isWysiwygEnabled":{"type":"boolean","description":"WYSIWYG flag"},"isHtmlAllowedOnFront":{"type":"boolean","description":"The HTML tags are allowed on the frontend"},"usedForSortBy":{"type":"boolean","description":"It is used for sorting in product listing"},"isFilterable":{"type":"boolean","description":"It used in layered navigation"},"isFilterableInSearch":{"type":"boolean","description":"It is used in search results layered navigation"},"isUsedInGrid":{"type":"boolean","description":"It is used in catalog product grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in catalog product grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in catalog product grid"},"position":{"type":"integer","description":"Position"},"applyTo":{"type":"array","description":"Apply to value for the element","items":{"type":"string"}},"isSearchable":{"type":"string","description":"The attribute can be used in Quick Search"},"isVisibleInAdvancedSearch":{"type":"string","description":"The attribute can be used in Advanced Search"},"isComparable":{"type":"string","description":"The attribute can be compared on the frontend"},"isUsedForPromoRules":{"type":"string","description":"The attribute can be used for promo rules"},"isVisibleOnFront":{"type":"string","description":"The attribute is visible on the frontend"},"usedInProductListing":{"type":"string","description":"The attribute can be used in product listing"},"isVisible":{"type":"boolean","description":"Attribute is visible on frontend."},"scope":{"type":"string","description":"Attribute scope"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"attributeId":{"type":"integer","description":"Id of the attribute."},"attributeCode":{"type":"string","description":"Code of the attribute."},"frontendInput":{"type":"string","description":"HTML for input element."},"entityTypeId":{"type":"string","description":"Entity type id"},"isRequired":{"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"}},"isUserDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"defaultFrontendLabel":{"type":"string","description":"Frontend label for default store"},"frontendLabels":{"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."},"backendType":{"type":"string","description":"Backend type."},"backendModel":{"type":"string","description":"Backend model"},"sourceModel":{"type":"string","description":"Source model"},"defaultValue":{"type":"string","description":"Default value for the element."},"isUnique":{"type":"string","description":"This is a unique attribute"},"frontendClass":{"type":"string","description":"Frontend class of attribute"},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/eav-data-attribute-validation-rule-interface"}},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["attributeCode","frontendInput","isRequired","frontendLabels"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"eav-data-attribute-option-interface":{"type":"object","description":"Created from:","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"sortOrder":{"type":"integer","description":"Option order"},"isDefault":{"type":"boolean","description":"Default"},"storeLabels":{"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":"","properties":{"storeId":{"type":"integer","description":"Store id"},"label":{"type":"string","description":"Option label"}}},"eav-data-attribute-frontend-label-interface":{"type":"object","description":"","properties":{"storeId":{"type":"integer","description":"Store id"},"label":{"type":"string","description":"Option label"}}},"eav-data-attribute-validation-rule-interface":{"type":"object","description":"","properties":{"key":{"type":"string","description":"Object key"},"value":{"type":"string","description":"Object value"}},"required":["key","value"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"isWysiwygEnabled":{"type":"boolean","description":"WYSIWYG flag"},"isHtmlAllowedOnFront":{"type":"boolean","description":"The HTML tags are allowed on the frontend"},"usedForSortBy":{"type":"boolean","description":"It is used for sorting in product listing"},"isFilterable":{"type":"boolean","description":"It used in layered navigation"},"isFilterableInSearch":{"type":"boolean","description":"It is used in search results layered navigation"},"isUsedInGrid":{"type":"boolean","description":"It is used in catalog product grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in catalog product grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in catalog product grid"},"position":{"type":"integer","description":"Position"},"applyTo":{"type":"array","description":"Apply to value for the element","items":{"type":"string"}},"isSearchable":{"type":"string","description":"The attribute can be used in Quick Search"},"isVisibleInAdvancedSearch":{"type":"string","description":"The attribute can be used in Advanced Search"},"isComparable":{"type":"string","description":"The attribute can be compared on the frontend"},"isUsedForPromoRules":{"type":"string","description":"The attribute can be used for promo rules"},"isVisibleOnFront":{"type":"string","description":"The attribute is visible on the frontend"},"usedInProductListing":{"type":"string","description":"The attribute can be used in product listing"},"isVisible":{"type":"boolean","description":"Attribute is visible on frontend."},"scope":{"type":"string","description":"Attribute scope"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"attributeId":{"type":"integer","description":"Id of the attribute."},"attributeCode":{"type":"string","description":"Code of the attribute."},"frontendInput":{"type":"string","description":"HTML for input element."},"entityTypeId":{"type":"string","description":"Entity type id"},"isRequired":{"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"}},"isUserDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"defaultFrontendLabel":{"type":"string","description":"Frontend label for default store"},"frontendLabels":{"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."},"backendType":{"type":"string","description":"Backend type."},"backendModel":{"type":"string","description":"Backend model"},"sourceModel":{"type":"string","description":"Source model"},"defaultValue":{"type":"string","description":"Default value for the element."},"isUnique":{"type":"string","description":"This is a unique attribute"},"frontendClass":{"type":"string","description":"Frontend class of attribute"},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/eav-data-attribute-validation-rule-interface"}},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["attributeCode","frontendInput","isRequired","frontendLabels"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"eav-data-attribute-group-interface":{"type":"object","description":"","properties":{"attributeGroupId":{"type":"string","description":"Id"},"attributeGroupName":{"type":"string","description":"Name"},"attributeSetId":{"type":"integer","description":"Attribute set id"},"extensionAttributes":{"$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"},"catalog-data-category-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"parentId":{"type":"integer","description":"Parent category ID"},"name":{"type":"string","description":"Category name"},"isActive":{"type":"boolean","description":"Whether category is active"},"position":{"type":"integer","description":"Category position"},"level":{"type":"integer","description":"Category level"},"children":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"path":{"type":"string"},"availableSortBy":{"type":"array","items":{"type":"string"}},"includeInMenu":{"type":"boolean"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"parentId":{"type":"integer","description":"Parent category ID"},"name":{"type":"string","description":"Category name"},"isActive":{"type":"boolean","description":"Whether category is active"},"position":{"type":"integer","description":"Category position"},"level":{"type":"integer","description":"Category level"},"productCount":{"type":"integer","description":"Product count"},"childrenData":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parentId","name","isActive","position","level","productCount","childrenData"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"catalog-data-category-product-link-interface":{"type":"object","description":"","properties":{"sku":{"type":"string"},"position":{"type":"integer"},"categoryId":{"type":"string","description":"Category id"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-category-product-link-extension-interface"}},"required":["categoryId"]},"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"},"websiteId":{"type":"integer","description":"Website ids"}},"required":["sku","websiteId"]},"framework-search-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"searchCriteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","aggregations","searchCriteria","totalCount"]},"framework-search-document-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucketNames":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucketNames"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"","properties":{"requestName":{"type":"string"},"filterGroups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sortOrders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"pageSize":{"type":"integer","description":"Page size."},"currentPage":{"type":"integer","description":"Current page."}},"required":["requestName","filterGroups"]},"quote-data-cart-interface":{"type":"object","description":"Interface CartInterface","properties":{"id":{"type":"integer","description":"Cart/quote ID."},"createdAt":{"type":"string","description":"Cart creation date and time. Otherwise, null."},"updatedAt":{"type":"string","description":"Cart last update date and time. Otherwise, null."},"convertedAt":{"type":"string","description":"Cart conversion date and time. Otherwise, null."},"isActive":{"type":"boolean","description":"Active status flag value. Otherwise, null."},"isVirtual":{"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"}},"itemsCount":{"type":"integer","description":"Number of different items or products in the cart. Otherwise, null."},"itemsQty":{"type":"number","description":"Total quantity of all cart items. Otherwise, null."},"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"reservedOrderId":{"type":"integer","description":"Reserved order ID. Otherwise, null."},"origOrderId":{"type":"integer","description":"Original order ID. Otherwise, null."},"currency":{"$ref":"#/definitions/quote-data-currency-interface"},"customerIsGuest":{"type":"boolean","description":"For guest customers, false for logged in customers"},"customerNote":{"type":"string","description":"Notice text"},"customerNoteNotify":{"type":"boolean","description":"Customer notification flag"},"customerTaxClassId":{"type":"integer","description":"Customer tax class ID."},"storeId":{"type":"integer","description":"Store identifier"},"extensionAttributes":{"$ref":"#/definitions/quote-data-cart-extension-interface"}},"required":["id","customer","storeId"]},"quote-data-cart-item-interface":{"type":"object","description":"Interface CartItemInterface","properties":{"itemId":{"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."},"productType":{"type":"string","description":"Product type. Otherwise, null."},"quoteId":{"type":"string","description":"Quote id."},"productOption":{"$ref":"#/definitions/quote-data-product-option-interface"},"extensionAttributes":{"$ref":"#/definitions/quote-data-cart-item-extension-interface"}},"required":["qty","quoteId"]},"quote-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extensionAttributes":{"$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":{"customOptions":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"bundleOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}},"downloadableOption":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"configurableItemOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}}}},"catalog-data-custom-option-interface":{"type":"object","description":"Interface CustomOptionInterface","properties":{"optionId":{"type":"string","description":"Option id"},"optionValue":{"type":"string","description":"Option value"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-custom-option-extension-interface"}},"required":["optionId","optionValue"]},"catalog-data-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CustomOptionInterface","properties":{"fileInfo":{"$ref":"#/definitions/framework-data-image-content-interface"}}},"bundle-data-bundle-option-interface":{"type":"object","description":"Interface BundleOptionInterface","properties":{"optionId":{"type":"integer","description":"Bundle option id."},"optionQty":{"type":"integer","description":"Bundle option quantity."},"optionSelections":{"type":"array","description":"Bundle option selection ids.","items":{"type":"integer"}},"extensionAttributes":{"$ref":"#/definitions/bundle-data-bundle-option-extension-interface"}},"required":["optionId","optionQty","optionSelections"]},"bundle-data-bundle-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\BundleOptionInterface"},"downloadable-data-downloadable-option-interface":{"type":"object","description":"Downloadable Option","properties":{"downloadableLinks":{"type":"array","description":"The list of downloadable links","items":{"type":"integer"}}},"required":["downloadableLinks"]},"configurable-product-data-configurable-item-option-value-interface":{"type":"object","description":"Interface ConfigurableItemOptionValueInterface","properties":{"optionId":{"type":"string","description":"Option SKU"},"optionValue":{"type":"integer","description":"Item id"},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-extension-interface"}},"required":["optionId"]},"configurable-product-data-configurable-item-option-value-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\ConfigurableProduct\\Api\\Data\\ConfigurableItemOptionValueInterface"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface"},"quote-data-address-interface":{"type":"object","description":"Interface AddressInterface","properties":{"id":{"type":"integer","description":"Id"},"region":{"type":"string","description":"Region name"},"regionId":{"type":"integer","description":"Region id"},"regionCode":{"type":"string","description":"Region code"},"countryId":{"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"},"vatId":{"type":"string","description":"Vat id"},"customerId":{"type":"integer","description":"Customer id"},"email":{"type":"string","description":"Billing/shipping email"},"sameAsBilling":{"type":"integer","description":"Same as billing flag"},"customerAddressId":{"type":"integer","description":"Customer address id"},"saveInAddressBook":{"type":"integer","description":"Save in address book flag"},"extensionAttributes":{"$ref":"#/definitions/quote-data-address-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["region","regionId","regionCode","countryId","street","telephone","postcode","city","firstname","lastname","email"]},"quote-data-address-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\AddressInterface"},"quote-data-currency-interface":{"type":"object","description":"Interface CurrencyInterface","properties":{"globalCurrencyCode":{"type":"string","description":"Global currency code"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"storeCurrencyCode":{"type":"string","description":"Store currency code"},"quoteCurrencyCode":{"type":"string","description":"Quote currency code"},"storeToBaseRate":{"type":"number","description":"Store currency to base currency rate"},"storeToQuoteRate":{"type":"number","description":"Store currency to quote currency rate"},"baseToGlobalRate":{"type":"number","description":"Base currency to global currency rate"},"baseToQuoteRate":{"type":"number","description":"Base currency to quote currency rate"},"extensionAttributes":{"$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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"quote-data-payment-interface":{"type":"object","description":"Interface PaymentInterface","properties":{"poNumber":{"type":"string","description":"Purchase order number"},"method":{"type":"string","description":"Payment method code"},"additionalData":{"type":"array","description":"Payment additional details","items":{"type":"string"}},"extensionAttributes":{"$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":{"agreementIds":{"type":"array","items":{"type":"string"}}}},"quote-data-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrierCode":{"type":"string","description":"Shipping carrier code."},"methodCode":{"type":"string","description":"Shipping method code."},"carrierTitle":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"methodTitle":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"baseAmount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extensionAttributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"errorMessage":{"type":"string","description":"Shipping Error message."},"priceExclTax":{"type":"number","description":"Shipping price excl tax."},"priceInclTax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrierCode","methodCode","amount","baseAmount","available","errorMessage","priceExclTax","priceInclTax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-estimate-address-interface":{"type":"object","description":"Interface EstimateAddressInterface","properties":{"region":{"type":"string","description":"Region name"},"regionId":{"type":"integer","description":"Region id"},"countryId":{"type":"string","description":"Country id"},"postcode":{"type":"string","description":"Postcode"},"extensionAttributes":{"$ref":"#/definitions/quote-data-estimate-address-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["region","regionId","countryId","postcode"]},"quote-data-estimate-address-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\EstimateAddressInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grandTotal":{"type":"number","description":"Grand total in quote currency"},"baseGrandTotal":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"baseSubtotal":{"type":"number","description":"Subtotal in base currency"},"discountAmount":{"type":"number","description":"Discount amount in quote currency"},"baseDiscountAmount":{"type":"number","description":"Discount amount in base currency"},"subtotalWithDiscount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"baseSubtotalWithDiscount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shippingAmount":{"type":"number","description":"Shipping amount in quote currency"},"baseShippingAmount":{"type":"number","description":"Shipping amount in base currency"},"shippingDiscountAmount":{"type":"number","description":"Shipping discount amount in quote currency"},"baseShippingDiscountAmount":{"type":"number","description":"Shipping discount amount in base currency"},"taxAmount":{"type":"number","description":"Tax amount in quote currency"},"baseTaxAmount":{"type":"number","description":"Tax amount in base currency"},"weeeTaxAppliedAmount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount in quote currency"},"baseShippingTaxAmount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotalInclTax":{"type":"number","description":"Subtotal including tax in quote currency"},"baseSubtotalInclTax":{"type":"number","description":"Subtotal including tax in base currency"},"shippingInclTax":{"type":"number","description":"Shipping including tax in quote currency"},"baseShippingInclTax":{"type":"number","description":"Shipping including tax in base currency"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"quoteCurrencyCode":{"type":"string","description":"Quote currency code"},"couponCode":{"type":"string","description":"Applied coupon code"},"itemsQty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"totalSegments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weeeTaxAppliedAmount","totalSegments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"itemId":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"basePrice":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"rowTotal":{"type":"number","description":"Row total in quote currency."},"baseRowTotal":{"type":"number","description":"Row total in base currency."},"rowTotalWithDiscount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"taxAmount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"baseTaxAmount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"taxPercent":{"type":"number","description":"Tax percent. Otherwise, null."},"discountAmount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"baseDiscountAmount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discountPercent":{"type":"number","description":"Discount percent. Otherwise, null."},"priceInclTax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"basePriceInclTax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"rowTotalInclTax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"baseRowTotalInclTax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weeeTaxAppliedAmount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weeeTaxApplied":{"type":"string","description":"Item weee tax applied in quote currency."},"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["itemId","price","basePrice","qty","rowTotal","baseRowTotal","options","weeeTaxAppliedAmount","weeeTaxApplied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extensionAttributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"taxGrandtotalDetails":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}}}},"tax-data-grand-total-details-interface":{"type":"object","description":"","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"groupId":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","groupId"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface"},"quote-data-totals-additional-data-interface":{"type":"object","description":"Additional data for totals collection.","properties":{"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-additional-data-extension-interface"},"customAttributes":{"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":{"giftMessages":{"type":"array","items":{"$ref":"#/definitions/gift-message-data-message-interface"}}}},"gift-message-data-message-interface":{"type":"object","description":"","properties":{"giftMessageId":{"type":"integer","description":"Gift message ID. Otherwise, null."},"customerId":{"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."},"extensionAttributes":{"$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":{"entityId":{"type":"string"},"entityType":{"type":"string"}}},"checkout-agreements-data-agreement-interface":{"type":"object","description":"","properties":{"agreementId":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"contentHeight":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkboxText":{"type":"string","description":"Agreement checkbox text."},"isActive":{"type":"boolean","description":"Agreement status."},"isHtml":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extensionAttributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreementId","name","content","checkboxText","isActive","isHtml","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extensionAttributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"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":{"adjustmentNegative":{"type":"number","description":"Negative adjustment value."},"adjustmentPositive":{"type":"number","description":"Positive adjustment value."},"appliedRuleIds":{"type":"string","description":"Applied rule IDs."},"baseAdjustmentNegative":{"type":"number","description":"Base negative adjustment value."},"baseAdjustmentPositive":{"type":"number","description":"Base positive adjustment value."},"baseCurrencyCode":{"type":"string","description":"Base currency code."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountCanceled":{"type":"number","description":"Base discount canceled."},"baseDiscountInvoiced":{"type":"number","description":"Base discount invoiced."},"baseDiscountRefunded":{"type":"number","description":"Base discount refunded."},"baseGrandTotal":{"type":"number","description":"Base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseDiscountTaxCompensationInvoiced":{"type":"number","description":"Base discount tax compensation invoiced."},"baseDiscountTaxCompensationRefunded":{"type":"number","description":"Base discount tax compensation refunded."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingCanceled":{"type":"number","description":"Base shipping canceled."},"baseShippingDiscountAmount":{"type":"number","description":"Base shipping discount amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Base shipping including tax."},"baseShippingInvoiced":{"type":"number","description":"Base shipping invoiced."},"baseShippingRefunded":{"type":"number","description":"Base shipping refunded."},"baseShippingTaxAmount":{"type":"number","description":"Base shipping tax amount."},"baseShippingTaxRefunded":{"type":"number","description":"Base shipping tax refunded."},"baseSubtotal":{"type":"number","description":"Base subtotal."},"baseSubtotalCanceled":{"type":"number","description":"Base subtotal canceled."},"baseSubtotalInclTax":{"type":"number","description":"Base subtotal including tax."},"baseSubtotalInvoiced":{"type":"number","description":"Base subtotal invoiced."},"baseSubtotalRefunded":{"type":"number","description":"Base subtotal refunded."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTaxCanceled":{"type":"number","description":"Base tax canceled."},"baseTaxInvoiced":{"type":"number","description":"Base tax invoiced."},"baseTaxRefunded":{"type":"number","description":"Base tax refunded."},"baseTotalCanceled":{"type":"number","description":"Base total canceled."},"baseTotalDue":{"type":"number","description":"Base total due."},"baseTotalInvoiced":{"type":"number","description":"Base total invoiced."},"baseTotalInvoicedCost":{"type":"number","description":"Base total invoiced cost."},"baseTotalOfflineRefunded":{"type":"number","description":"Base total offline refunded."},"baseTotalOnlineRefunded":{"type":"number","description":"Base total online refunded."},"baseTotalPaid":{"type":"number","description":"Base total paid."},"baseTotalQtyOrdered":{"type":"number","description":"Base total quantity ordered."},"baseTotalRefunded":{"type":"number","description":"Base total refunded."},"baseToGlobalRate":{"type":"number","description":"Base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Base-to-order rate."},"billingAddressId":{"type":"integer","description":"Billing address ID."},"canShipPartially":{"type":"integer","description":"Can-ship-partially flag value."},"canShipPartiallyItem":{"type":"integer","description":"Can-ship-partially-item flag value."},"couponCode":{"type":"string","description":"Coupon code."},"createdAt":{"type":"string","description":"Created-at timestamp."},"customerDob":{"type":"string","description":"Customer date-of-birth (DOB)."},"customerEmail":{"type":"string","description":"Customer email address."},"customerFirstname":{"type":"string","description":"Customer first name."},"customerGender":{"type":"integer","description":"Customer gender."},"customerGroupId":{"type":"integer","description":"Customer group ID."},"customerId":{"type":"integer","description":"Customer ID."},"customerIsGuest":{"type":"integer","description":"Customer-is-guest flag value."},"customerLastname":{"type":"string","description":"Customer last name."},"customerMiddlename":{"type":"string","description":"Customer middle name."},"customerNote":{"type":"string","description":"Customer note."},"customerNoteNotify":{"type":"integer","description":"Customer-note-notify flag value."},"customerPrefix":{"type":"string","description":"Customer prefix."},"customerSuffix":{"type":"string","description":"Customer suffix."},"customerTaxvat":{"type":"string","description":"Customer value-added tax (VAT)."},"discountAmount":{"type":"number","description":"Discount amount."},"discountCanceled":{"type":"number","description":"Discount canceled."},"discountDescription":{"type":"string","description":"Discount description."},"discountInvoiced":{"type":"number","description":"Discount invoiced."},"discountRefunded":{"type":"number","description":"Discount refunded amount."},"editIncrement":{"type":"integer","description":"Edit increment value."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Order ID."},"extCustomerId":{"type":"string","description":"External customer ID."},"extOrderId":{"type":"string","description":"External order ID."},"forcedShipmentWithInvoice":{"type":"integer","description":"Forced-shipment-with-invoice flag value."},"globalCurrencyCode":{"type":"string","description":"Global currency code."},"grandTotal":{"type":"number","description":"Grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"discountTaxCompensationInvoiced":{"type":"number","description":"Discount tax compensation invoiced amount."},"discountTaxCompensationRefunded":{"type":"number","description":"Discount tax compensation refunded amount."},"holdBeforeState":{"type":"string","description":"Hold before state."},"holdBeforeStatus":{"type":"string","description":"Hold before status."},"incrementId":{"type":"string","description":"Increment ID."},"isVirtual":{"type":"integer","description":"Is-virtual flag value."},"orderCurrencyCode":{"type":"string","description":"Order currency code."},"originalIncrementId":{"type":"string","description":"Original increment ID."},"paymentAuthorizationAmount":{"type":"number","description":"Payment authorization amount."},"paymentAuthExpiration":{"type":"integer","description":"Payment authorization expiration date."},"protectCode":{"type":"string","description":"Protect code."},"quoteAddressId":{"type":"integer","description":"Quote address ID."},"quoteId":{"type":"integer","description":"Quote ID."},"relationChildId":{"type":"string","description":"Relation child ID."},"relationChildRealId":{"type":"string","description":"Relation child real ID."},"relationParentId":{"type":"string","description":"Relation parent ID."},"relationParentRealId":{"type":"string","description":"Relation parent real ID."},"remoteIp":{"type":"string","description":"Remote IP address."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingCanceled":{"type":"number","description":"Shipping canceled amount."},"shippingDescription":{"type":"string","description":"Shipping description."},"shippingDiscountAmount":{"type":"number","description":"Shipping discount amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Shipping including tax amount."},"shippingInvoiced":{"type":"number","description":"Shipping invoiced amount."},"shippingRefunded":{"type":"number","description":"Shipping refunded amount."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount."},"shippingTaxRefunded":{"type":"number","description":"Shipping tax refunded amount."},"state":{"type":"string","description":"State."},"status":{"type":"string","description":"Status."},"storeCurrencyCode":{"type":"string","description":"Store currency code."},"storeId":{"type":"integer","description":"Store ID."},"storeName":{"type":"string","description":"Store name."},"storeToBaseRate":{"type":"number","description":"Store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Store-to-order rate."},"subtotal":{"type":"number","description":"Subtotal."},"subtotalCanceled":{"type":"number","description":"Subtotal canceled amount."},"subtotalInclTax":{"type":"number","description":"Subtotal including tax amount."},"subtotalInvoiced":{"type":"number","description":"Subtotal invoiced amount."},"subtotalRefunded":{"type":"number","description":"Subtotal refunded amount."},"taxAmount":{"type":"number","description":"Tax amount."},"taxCanceled":{"type":"number","description":"Tax canceled amount."},"taxInvoiced":{"type":"number","description":"Tax invoiced amount."},"taxRefunded":{"type":"number","description":"Tax refunded amount."},"totalCanceled":{"type":"number","description":"Total canceled."},"totalDue":{"type":"number","description":"Total due."},"totalInvoiced":{"type":"number","description":"Total invoiced amount."},"totalItemCount":{"type":"integer","description":"Total item count."},"totalOfflineRefunded":{"type":"number","description":"Total offline refunded amount."},"totalOnlineRefunded":{"type":"number","description":"Total online refunded amount."},"totalPaid":{"type":"number","description":"Total paid."},"totalQtyOrdered":{"type":"number","description":"Total quantity ordered."},"totalRefunded":{"type":"number","description":"Total amount refunded."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"xForwardedFor":{"type":"string","description":"X-Forwarded-For field value."},"items":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"billingAddress":{"$ref":"#/definitions/sales-data-order-address-interface"},"payment":{"$ref":"#/definitions/sales-data-order-payment-interface"},"statusHistories":{"type":"array","description":"Array of status histories.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-extension-interface"}},"required":["baseGrandTotal","baseDiscountTaxCompensationAmount","baseDiscountTaxCompensationInvoiced","baseDiscountTaxCompensationRefunded","baseShippingDiscountTaxCompensationAmnt","customerEmail","grandTotal","discountTaxCompensationAmount","discountTaxCompensationInvoiced","discountTaxCompensationRefunded","shippingDiscountTaxCompensationAmount","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":{"additionalData":{"type":"string","description":"Additional data."},"amountRefunded":{"type":"number","description":"Amount refunded."},"appliedRuleIds":{"type":"string","description":"Applied rule IDs."},"baseAmountRefunded":{"type":"number","description":"Base amount refunded."},"baseCost":{"type":"number","description":"Base cost."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountInvoiced":{"type":"number","description":"Base discount invoiced."},"baseDiscountRefunded":{"type":"number","description":"Base discount refunded."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseDiscountTaxCompensationInvoiced":{"type":"number","description":"Base discount tax compensation invoiced."},"baseDiscountTaxCompensationRefunded":{"type":"number","description":"Base discount tax compensation refunded."},"baseOriginalPrice":{"type":"number","description":"Base original price."},"basePrice":{"type":"number","description":"Base price."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowInvoiced":{"type":"number","description":"Base row invoiced."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTaxBeforeDiscount":{"type":"number","description":"Base tax before discount."},"baseTaxInvoiced":{"type":"number","description":"Base tax invoiced."},"baseTaxRefunded":{"type":"number","description":"Base tax refunded."},"baseWeeeTaxAppliedAmount":{"type":"number","description":"Base WEEE tax applied amount."},"baseWeeeTaxAppliedRowAmnt":{"type":"number","description":"Base WEEE tax applied row amount."},"baseWeeeTaxDisposition":{"type":"number","description":"Base WEEE tax disposition."},"baseWeeeTaxRowDisposition":{"type":"number","description":"Base WEEE tax row disposition."},"createdAt":{"type":"string","description":"Created-at timestamp."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"discountInvoiced":{"type":"number","description":"Discount invoiced."},"discountPercent":{"type":"number","description":"Discount percent."},"discountRefunded":{"type":"number","description":"Discount refunded."},"eventId":{"type":"integer","description":"Event ID."},"extOrderItemId":{"type":"string","description":"External order item ID."},"freeShipping":{"type":"integer","description":"Free-shipping flag value."},"gwBasePrice":{"type":"number","description":"GW base price."},"gwBasePriceInvoiced":{"type":"number","description":"GW base price invoiced."},"gwBasePriceRefunded":{"type":"number","description":"GW base price refunded."},"gwBaseTaxAmount":{"type":"number","description":"GW base tax amount."},"gwBaseTaxAmountInvoiced":{"type":"number","description":"GW base tax amount invoiced."},"gwBaseTaxAmountRefunded":{"type":"number","description":"GW base tax amount refunded."},"gwId":{"type":"integer","description":"GW ID."},"gwPrice":{"type":"number","description":"GW price."},"gwPriceInvoiced":{"type":"number","description":"GW price invoiced."},"gwPriceRefunded":{"type":"number","description":"GW price refunded."},"gwTaxAmount":{"type":"number","description":"GW tax amount."},"gwTaxAmountInvoiced":{"type":"number","description":"GW tax amount invoiced."},"gwTaxAmountRefunded":{"type":"number","description":"GW tax amount refunded."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"discountTaxCompensationCanceled":{"type":"number","description":"Discount tax compensation canceled."},"discountTaxCompensationInvoiced":{"type":"number","description":"Discount tax compensation invoiced."},"discountTaxCompensationRefunded":{"type":"number","description":"Discount tax compensation refunded."},"isQtyDecimal":{"type":"integer","description":"Is-quantity-decimal flag value."},"isVirtual":{"type":"integer","description":"Is-virtual flag value."},"itemId":{"type":"integer","description":"Item ID."},"lockedDoInvoice":{"type":"integer","description":"Locked DO invoice flag value."},"lockedDoShip":{"type":"integer","description":"Locked DO ship flag value."},"name":{"type":"string","description":"Name."},"noDiscount":{"type":"integer","description":"No-discount flag value."},"orderId":{"type":"integer","description":"Order ID."},"originalPrice":{"type":"number","description":"Original price."},"parentItemId":{"type":"integer","description":"Parent item ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"productType":{"type":"string","description":"Product type."},"qtyBackordered":{"type":"number","description":"Quantity backordered."},"qtyCanceled":{"type":"number","description":"Quantity canceled."},"qtyInvoiced":{"type":"number","description":"Quantity invoiced."},"qtyOrdered":{"type":"number","description":"Quantity ordered."},"qtyRefunded":{"type":"number","description":"Quantity refunded."},"qtyReturned":{"type":"number","description":"Quantity returned."},"qtyShipped":{"type":"number","description":"Quantity shipped."},"quoteItemId":{"type":"integer","description":"Quote item ID."},"rowInvoiced":{"type":"number","description":"Row invoiced."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"rowWeight":{"type":"number","description":"Row weight."},"sku":{"type":"string","description":"SKU."},"storeId":{"type":"integer","description":"Store ID."},"taxAmount":{"type":"number","description":"Tax amount."},"taxBeforeDiscount":{"type":"number","description":"Tax before discount."},"taxCanceled":{"type":"number","description":"Tax canceled."},"taxInvoiced":{"type":"number","description":"Tax invoiced."},"taxPercent":{"type":"number","description":"Tax percent."},"taxRefunded":{"type":"number","description":"Tax refunded."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weeeTaxApplied":{"type":"string","description":"WEEE tax applied."},"weeeTaxAppliedAmount":{"type":"number","description":"WEEE tax applied amount."},"weeeTaxAppliedRowAmount":{"type":"number","description":"WEEE tax applied row amount."},"weeeTaxDisposition":{"type":"number","description":"WEEE tax disposition."},"weeeTaxRowDisposition":{"type":"number","description":"WEEE tax row disposition."},"weight":{"type":"number","description":"Weight."},"parentItem":{"$ref":"#/definitions/sales-data-order-item-interface"},"productOption":{"$ref":"#/definitions/catalog-data-product-option-interface"},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-item-extension-interface"}},"required":["baseDiscountTaxCompensationAmount","baseDiscountTaxCompensationInvoiced","baseDiscountTaxCompensationRefunded","discountTaxCompensationAmount","discountTaxCompensationCanceled","discountTaxCompensationInvoiced","discountTaxCompensationRefunded","sku"]},"catalog-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extensionAttributes":{"$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":{"customOptions":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"bundleOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}},"downloadableOption":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"configurableItemOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}}}},"sales-data-order-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderItemInterface","properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}}},"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":{"addressType":{"type":"string","description":"Address type."},"city":{"type":"string","description":"City."},"company":{"type":"string","description":"Company."},"countryId":{"type":"string","description":"Country ID."},"customerAddressId":{"type":"integer","description":"Country address ID."},"customerId":{"type":"integer","description":"Customer ID."},"email":{"type":"string","description":"Email address."},"entityId":{"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."},"parentId":{"type":"integer","description":"Parent ID."},"postcode":{"type":"string","description":"Postal code."},"prefix":{"type":"string","description":"Prefix."},"region":{"type":"string","description":"Region."},"regionCode":{"type":"string","description":"Region code."},"regionId":{"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."},"vatId":{"type":"string","description":"VAT ID."},"vatIsValid":{"type":"integer","description":"VAT-is-valid flag value."},"vatRequestDate":{"type":"string","description":"VAT request date."},"vatRequestId":{"type":"string","description":"VAT request ID."},"vatRequestSuccess":{"type":"integer","description":"VAT-request-success flag value."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-address-extension-interface"}},"required":["addressType","city","countryId","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":{"accountStatus":{"type":"string","description":"Account status."},"additionalData":{"type":"string","description":"Additional data."},"additionalInformation":{"type":"array","description":"Array of additional information.","items":{"type":"string"}},"addressStatus":{"type":"string","description":"Address status."},"amountAuthorized":{"type":"number","description":"Amount authorized."},"amountCanceled":{"type":"number","description":"Amount canceled."},"amountOrdered":{"type":"number","description":"Amount ordered."},"amountPaid":{"type":"number","description":"Amount paid."},"amountRefunded":{"type":"number","description":"Amount refunded."},"anetTransMethod":{"type":"string","description":"Anet transaction method."},"baseAmountAuthorized":{"type":"number","description":"Base amount authorized."},"baseAmountCanceled":{"type":"number","description":"Base amount canceled."},"baseAmountOrdered":{"type":"number","description":"Base amount ordered."},"baseAmountPaid":{"type":"number","description":"Base amount paid."},"baseAmountPaidOnline":{"type":"number","description":"Base amount paid online."},"baseAmountRefunded":{"type":"number","description":"Base amount refunded."},"baseAmountRefundedOnline":{"type":"number","description":"Base amount refunded online."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingCaptured":{"type":"number","description":"Base shipping captured amount."},"baseShippingRefunded":{"type":"number","description":"Base shipping refunded amount."},"ccApproval":{"type":"string","description":"Credit card approval."},"ccAvsStatus":{"type":"string","description":"Credit card avs status."},"ccCidStatus":{"type":"string","description":"Credit card CID status."},"ccDebugRequestBody":{"type":"string","description":"Credit card debug request body."},"ccDebugResponseBody":{"type":"string","description":"Credit card debug response body."},"ccDebugResponseSerialized":{"type":"string","description":"Credit card debug response serialized."},"ccExpMonth":{"type":"string","description":"Credit card expiration month."},"ccExpYear":{"type":"string","description":"Credit card expiration year."},"ccLast4":{"type":"string","description":"Last four digits of the credit card."},"ccNumberEnc":{"type":"string","description":"Encrypted credit card number."},"ccOwner":{"type":"string","description":"Credit card number."},"ccSecureVerify":{"type":"string","description":"Credit card secure verify."},"ccSsIssue":{"type":"string","description":"Credit card SS issue."},"ccSsStartMonth":{"type":"string","description":"Credit card SS start month."},"ccSsStartYear":{"type":"string","description":"Credit card SS start year."},"ccStatus":{"type":"string","description":"Credit card status."},"ccStatusDescription":{"type":"string","description":"Credit card status description."},"ccTransId":{"type":"string","description":"Credit card transaction ID."},"ccType":{"type":"string","description":"Credit card type."},"echeckAccountName":{"type":"string","description":"eCheck account name."},"echeckAccountType":{"type":"string","description":"eCheck account type."},"echeckBankName":{"type":"string","description":"eCheck bank name."},"echeckRoutingNumber":{"type":"string","description":"eCheck routing number."},"echeckType":{"type":"string","description":"eCheck type."},"entityId":{"type":"integer","description":"Entity ID."},"lastTransId":{"type":"string","description":"Last transaction ID."},"method":{"type":"string","description":"Method."},"parentId":{"type":"integer","description":"Parent ID."},"poNumber":{"type":"string","description":"PO number."},"protectionEligibility":{"type":"string","description":"Protection eligibility."},"quotePaymentId":{"type":"integer","description":"Quote payment ID."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingCaptured":{"type":"number","description":"Shipping captured."},"shippingRefunded":{"type":"number","description":"Shipping refunded."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-payment-extension-interface"}},"required":["accountStatus","additionalInformation","ccLast4","method"]},"sales-data-order-payment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderPaymentInterface"},"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."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Order status history ID."},"entityName":{"type":"string","description":"Entity name."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"status":{"type":"string","description":"Status."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-status-history-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"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":{"appliedTaxes":{"type":"array","items":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-interface"}},"itemAppliedTaxes":{"type":"array","items":{"$ref":"#/definitions/tax-data-order-tax-details-item-interface"}},"convertingFromQuote":{"type":"boolean"},"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}}},"tax-data-order-tax-details-applied-tax-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Title"},"percent":{"type":"number","description":"Tax Percent"},"amount":{"type":"number","description":"Tax amount"},"baseAmount":{"type":"number","description":"Tax amount in base currency"},"extensionAttributes":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-extension-interface"}},"required":["amount","baseAmount"]},"tax-data-order-tax-details-applied-tax-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\OrderTaxDetailsAppliedTaxInterface"},"tax-data-order-tax-details-item-interface":{"type":"object","description":"","properties":{"type":{"type":"string","description":"Type (shipping, product, weee, gift wrapping, etc)"},"itemId":{"type":"integer","description":"Item id if this item is a product"},"associatedItemId":{"type":"integer","description":"Associated item id if this item is associated with another item, null otherwise"},"appliedTaxes":{"type":"array","description":"Applied taxes","items":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-interface"}},"extensionAttributes":{"$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"},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-invoice-interface":{"type":"object","description":"Invoice interface. An invoice is a record of the receipt of payment for an order.","properties":{"baseCurrencyCode":{"type":"string","description":"Base currency code."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseGrandTotal":{"type":"number","description":"Base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Base shipping including tax."},"baseShippingTaxAmount":{"type":"number","description":"Base shipping tax amount."},"baseSubtotal":{"type":"number","description":"Base subtotal."},"baseSubtotalInclTax":{"type":"number","description":"Base subtotal including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTotalRefunded":{"type":"number","description":"Base total refunded."},"baseToGlobalRate":{"type":"number","description":"Base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Base-to-order rate."},"billingAddressId":{"type":"integer","description":"Billing address ID."},"canVoidFlag":{"type":"integer","description":"Can void flag value."},"createdAt":{"type":"string","description":"Created-at timestamp."},"discountAmount":{"type":"number","description":"Discount amount."},"discountDescription":{"type":"string","description":"Discount description."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Invoice ID."},"globalCurrencyCode":{"type":"string","description":"Global currency code."},"grandTotal":{"type":"number","description":"Grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"incrementId":{"type":"string","description":"Increment ID."},"isUsedForRefund":{"type":"integer","description":"Is-used-for-refund flag value."},"orderCurrencyCode":{"type":"string","description":"Order currency code."},"orderId":{"type":"integer","description":"Order ID."},"shippingAddressId":{"type":"integer","description":"Shipping address ID."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Shipping including tax."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount."},"state":{"type":"integer","description":"State."},"storeCurrencyCode":{"type":"string","description":"Store currency code."},"storeId":{"type":"integer","description":"Store ID."},"storeToBaseRate":{"type":"number","description":"Store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Store-to-order rate."},"subtotal":{"type":"number","description":"Subtotal."},"subtotalInclTax":{"type":"number","description":"Subtotal including tax."},"taxAmount":{"type":"number","description":"Tax amount."},"totalQty":{"type":"number","description":"Total quantity."},"transactionId":{"type":"string","description":"Transaction ID."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-extension-interface"}},"required":["baseDiscountTaxCompensationAmount","baseShippingDiscountTaxCompensationAmnt","discountTaxCompensationAmount","orderId","shippingDiscountTaxCompensationAmount","totalQty","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":{"additionalData":{"type":"string","description":"Additional data."},"baseCost":{"type":"number","description":"Base cost."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"basePrice":{"type":"number","description":"Base price."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"entityId":{"type":"integer","description":"Invoice item ID."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"name":{"type":"string","description":"Name."},"orderItemId":{"type":"integer","description":"Order item ID."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"qty":{"type":"number","description":"Quantity."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"sku":{"type":"string","description":"SKU."},"taxAmount":{"type":"number","description":"Tax amount."},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-item-extension-interface"}},"required":["baseDiscountTaxCompensationAmount","discountTaxCompensationAmount","orderItemId","qty","sku"]},"sales-data-invoice-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceItemInterface"},"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":{"comment":{"type":"string","description":"Comment."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Invoice ID."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-comment-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"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"},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-creditmemo-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Credit memo ID."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-comment-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"sales-data-creditmemo-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoCommentInterface"},"sales-data-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"adjustmentNegative":{"type":"number","description":"Credit memo negative adjustment."},"adjustmentPositive":{"type":"number","description":"Credit memo positive adjustment."},"baseAdjustment":{"type":"number","description":"Credit memo base adjustment."},"baseAdjustmentNegative":{"type":"number","description":"Credit memo negative base adjustment."},"baseAdjustmentPositive":{"type":"number","description":"Credit memo positive base adjustment."},"baseCurrencyCode":{"type":"string","description":"Credit memo base currency code."},"baseDiscountAmount":{"type":"number","description":"Credit memo base discount amount."},"baseGrandTotal":{"type":"number","description":"Credit memo base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Credit memo base discount tax compensation amount."},"baseShippingAmount":{"type":"number","description":"Credit memo base shipping amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Credit memo base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Credit memo base shipping including tax."},"baseShippingTaxAmount":{"type":"number","description":"Credit memo base shipping tax amount."},"baseSubtotal":{"type":"number","description":"Credit memo base subtotal."},"baseSubtotalInclTax":{"type":"number","description":"Credit memo base subtotal including tax."},"baseTaxAmount":{"type":"number","description":"Credit memo base tax amount."},"baseToGlobalRate":{"type":"number","description":"Credit memo base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Credit memo base-to-order rate."},"billingAddressId":{"type":"integer","description":"Credit memo billing address ID."},"createdAt":{"type":"string","description":"Credit memo created-at timestamp."},"creditmemoStatus":{"type":"integer","description":"Credit memo status."},"discountAmount":{"type":"number","description":"Credit memo discount amount."},"discountDescription":{"type":"string","description":"Credit memo discount description."},"emailSent":{"type":"integer","description":"Credit memo email sent flag value."},"entityId":{"type":"integer","description":"Credit memo ID."},"globalCurrencyCode":{"type":"string","description":"Credit memo global currency code."},"grandTotal":{"type":"number","description":"Credit memo grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Credit memo discount tax compensation amount."},"incrementId":{"type":"string","description":"Credit memo increment ID."},"invoiceId":{"type":"integer","description":"Credit memo invoice ID."},"orderCurrencyCode":{"type":"string","description":"Credit memo order currency code."},"orderId":{"type":"integer","description":"Credit memo order ID."},"shippingAddressId":{"type":"integer","description":"Credit memo shipping address ID."},"shippingAmount":{"type":"number","description":"Credit memo shipping amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Credit memo shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Credit memo shipping including tax."},"shippingTaxAmount":{"type":"number","description":"Credit memo shipping tax amount."},"state":{"type":"integer","description":"Credit memo state."},"storeCurrencyCode":{"type":"string","description":"Credit memo store currency code."},"storeId":{"type":"integer","description":"Credit memo store ID."},"storeToBaseRate":{"type":"number","description":"Credit memo store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Credit memo store-to-order rate."},"subtotal":{"type":"number","description":"Credit memo subtotal."},"subtotalInclTax":{"type":"number","description":"Credit memo subtotal including tax."},"taxAmount":{"type":"number","description":"Credit memo tax amount."},"transactionId":{"type":"string","description":"Credit memo transaction ID."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-extension-interface"}},"required":["baseDiscountTaxCompensationAmount","baseShippingDiscountTaxCompensationAmnt","discountTaxCompensationAmount","orderId","shippingDiscountTaxCompensationAmount","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":{"additionalData":{"type":"string","description":"Additional data."},"baseCost":{"type":"number","description":"The base cost for a credit memo item."},"baseDiscountAmount":{"type":"number","description":"The base discount amount for a credit memo item."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"The base discount tax compensation amount for a credit memo item."},"basePrice":{"type":"number","description":"The base price for a credit memo item."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseWeeeTaxAppliedAmount":{"type":"number","description":"Base WEEE tax applied amount."},"baseWeeeTaxAppliedRowAmnt":{"type":"number","description":"Base WEEE tax applied row amount."},"baseWeeeTaxDisposition":{"type":"number","description":"Base WEEE tax disposition."},"baseWeeeTaxRowDisposition":{"type":"number","description":"Base WEEE tax row disposition."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"entityId":{"type":"integer","description":"Credit memo item ID."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"name":{"type":"string","description":"Name."},"orderItemId":{"type":"integer","description":"Order item ID."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"qty":{"type":"number","description":"Quantity."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"sku":{"type":"string","description":"SKU."},"taxAmount":{"type":"number","description":"Tax amount."},"weeeTaxApplied":{"type":"string","description":"WEEE tax applied."},"weeeTaxAppliedAmount":{"type":"number","description":"WEEE tax applied amount."},"weeeTaxAppliedRowAmount":{"type":"number","description":"WEEE tax applied row amount."},"weeeTaxDisposition":{"type":"number","description":"WEEE tax disposition."},"weeeTaxRowDisposition":{"type":"number","description":"WEEE tax row disposition."},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-item-extension-interface"}},"required":["baseCost","baseDiscountAmount","baseDiscountTaxCompensationAmount","basePrice","entityId","discountTaxCompensationAmount","orderItemId","qty"]},"sales-data-creditmemo-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoItemInterface"},"sales-data-creditmemo-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoInterface"},"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":{"billingAddressId":{"type":"integer","description":"Billing address ID."},"createdAt":{"type":"string","description":"Created-at timestamp."},"customerId":{"type":"integer","description":"Customer ID."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Shipment ID."},"incrementId":{"type":"string","description":"Increment ID."},"orderId":{"type":"integer","description":"Order ID."},"packages":{"type":"array","description":"Array of packages, if any. Otherwise, null.","items":{"$ref":"#/definitions/sales-data-shipment-package-interface"}},"shipmentStatus":{"type":"integer","description":"Shipment status."},"shippingAddressId":{"type":"integer","description":"Shipping address ID."},"shippingLabel":{"type":"string","description":"Shipping label."},"storeId":{"type":"integer","description":"Store ID."},"totalQty":{"type":"number","description":"Total quantity."},"totalWeight":{"type":"number","description":"Total weight."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-extension-interface"}},"required":["orderId","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":{"extensionAttributes":{"$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":{"additionalData":{"type":"string","description":"Additional data."},"description":{"type":"string","description":"Description."},"entityId":{"type":"integer","description":"Shipment item ID."},"name":{"type":"string","description":"Name."},"orderItemId":{"type":"integer","description":"Order item ID."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"productId":{"type":"integer","description":"Product ID."},"qty":{"type":"number","description":"Quantity."},"rowTotal":{"type":"number","description":"Row total."},"sku":{"type":"string","description":"SKU."},"weight":{"type":"number","description":"Weight."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-item-extension-interface"}},"required":["orderItemId","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":{"carrierCode":{"type":"string","description":"Carrier code."},"createdAt":{"type":"string","description":"Created-at timestamp."},"description":{"type":"string","description":"Description."},"entityId":{"type":"integer","description":"Shipment package ID."},"orderId":{"type":"integer","description":"The order_id for the shipment package."},"parentId":{"type":"integer","description":"Parent ID."},"qty":{"type":"number","description":"Quantity."},"title":{"type":"string","description":"Title."},"trackNumber":{"type":"string","description":"Track number."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-track-extension-interface"}},"required":["carrierCode","description","orderId","parentId","qty","title","trackNumber","weight"]},"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":{"comment":{"type":"string","description":"Comment."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Shipment comment ID."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-comment-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"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"},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transactionId":{"type":"integer","description":"Transaction ID."},"parentId":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"orderId":{"type":"integer","description":"Order ID."},"paymentId":{"type":"integer","description":"Payment ID."},"txnId":{"type":"string","description":"Transaction business ID."},"parentTxnId":{"type":"string","description":"Parent transaction business ID."},"txnType":{"type":"string","description":"Transaction type."},"isClosed":{"type":"integer","description":"Is-closed flag value."},"additionalInformation":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"createdAt":{"type":"string","description":"Created-at timestamp."},"childTransactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transactionId","orderId","paymentId","txnId","parentTxnId","txnType","isClosed","createdAt","childTransactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-inventory-data-stock-status-collection-interface":{"type":"object","description":"Stock Status collection interface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"searchCriteria":{"$ref":"#/definitions/catalog-inventory-stock-status-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"productId":{"type":"integer"},"websiteId":{"type":"integer"},"stockId":{"type":"integer"},"qty":{"type":"integer"},"stockStatus":{"type":"integer"},"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extensionAttributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["productId","websiteId","stockId","qty","stockStatus","stockItem"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"catalog-inventory-stock-status-criteria-interface":{"type":"object","description":"Interface StockStatusCriteriaInterface","properties":{"mapperInterfaceName":{"type":"string","description":"Associated Mapper Interface name"},"criteriaList":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapperInterfaceName","criteriaList","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapperInterfaceName":{"type":"string","description":"Associated Mapper Interface name"},"criteriaList":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapperInterfaceName","criteriaList","filters","orders","limit"]},"checkout-data-shipping-information-interface":{"type":"object","description":"","properties":{"shippingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"shippingMethodCode":{"type":"string","description":"Shipping method code"},"shippingCarrierCode":{"type":"string","description":"Carrier code"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-shipping-information-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["shippingAddress","shippingMethodCode","shippingCarrierCode"]},"checkout-data-shipping-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\ShippingInformationInterface"},"checkout-data-payment-details-interface":{"type":"object","description":"","properties":{"paymentMethods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["paymentMethods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"checkout-data-totals-information-interface":{"type":"object","description":"","properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"shippingMethodCode":{"type":"string","description":"Shipping method code"},"shippingCarrierCode":{"type":"string","description":"Carrier code"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-totals-information-extension-interface"},"customAttributes":{"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":{"ruleId":{"type":"integer","description":"Rule id"},"name":{"type":"string","description":"Rule name"},"storeLabels":{"type":"array","description":"Display label","items":{"$ref":"#/definitions/sales-rule-data-rule-label-interface"}},"description":{"type":"string","description":"Description"},"websiteIds":{"type":"array","description":"A list of websites the rule applies to","items":{"type":"integer"}},"customerGroupIds":{"type":"array","description":"Ids of customer groups that the rule applies to","items":{"type":"integer"}},"fromDate":{"type":"string","description":"The start date when the coupon is active"},"toDate":{"type":"string","description":"The end date when the coupon is active"},"usesPerCustomer":{"type":"integer","description":"Number of uses per customer"},"isActive":{"type":"boolean","description":"The coupon is active"},"condition":{"$ref":"#/definitions/sales-rule-data-condition-interface"},"actionCondition":{"$ref":"#/definitions/sales-rule-data-condition-interface"},"stopRulesProcessing":{"type":"boolean","description":"To stop rule processing"},"isAdvanced":{"type":"boolean","description":"Is this field needed"},"productIds":{"type":"array","description":"Product ids","items":{"type":"integer"}},"sortOrder":{"type":"integer","description":"Sort order"},"simpleAction":{"type":"string","description":"Simple action of the rule"},"discountAmount":{"type":"number","description":"Discount amount"},"discountQty":{"type":"number","description":"Maximum qty discount is applied"},"discountStep":{"type":"integer","description":"Discount step"},"applyToShipping":{"type":"boolean","description":"The rule applies to shipping"},"timesUsed":{"type":"integer","description":"How many times the rule has been used"},"isRss":{"type":"boolean","description":"Whether the rule is in RSS"},"couponType":{"type":"string","description":"Coupon type"},"useAutoGeneration":{"type":"boolean","description":"To auto generate coupon"},"usesPerCoupon":{"type":"integer","description":"Limit of uses per coupon"},"simpleFreeShipping":{"type":"string","description":"To grant free shipping"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-rule-extension-interface"}},"required":["websiteIds","customerGroupIds","usesPerCustomer","isActive","stopRulesProcessing","isAdvanced","sortOrder","discountAmount","discountStep","applyToShipping","timesUsed","isRss","couponType","useAutoGeneration","usesPerCoupon"]},"sales-rule-data-rule-label-interface":{"type":"object","description":"Interface RuleLabelInterface","properties":{"storeId":{"type":"integer","description":"StoreId"},"storeLabel":{"type":"string","description":"The label for the store"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-rule-label-extension-interface"}},"required":["storeId","storeLabel"]},"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":{"conditionType":{"type":"string","description":"Condition type"},"conditions":{"type":"array","description":"List of conditions","items":{"$ref":"#/definitions/sales-rule-data-condition-interface"}},"aggregatorType":{"type":"string","description":"The aggregator type"},"operator":{"type":"string","description":"The operator of the condition"},"attributeName":{"type":"string","description":"The attribute name of the condition"},"value":{"type":"string","description":"The value of the condition"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-condition-extension-interface"}},"required":["conditionType","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"},"sales-rule-data-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-rule-data-coupon-interface":{"type":"object","description":"Interface CouponInterface","properties":{"couponId":{"type":"integer","description":"Coupon id"},"ruleId":{"type":"integer","description":"The id of the rule associated with the coupon"},"code":{"type":"string","description":"Coupon code"},"usageLimit":{"type":"integer","description":"Usage limit"},"usagePerCustomer":{"type":"integer","description":"Usage limit per customer"},"timesUsed":{"type":"integer","description":"The number of times the coupon has been used"},"expirationDate":{"type":"string","description":"Expiration date"},"isPrimary":{"type":"boolean","description":"The coupon is primary coupon for the rule that it's associated with"},"createdAt":{"type":"string","description":"When the coupon is created"},"type":{"type":"integer","description":"Of coupon"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-coupon-extension-interface"}},"required":["ruleId","timesUsed","isPrimary"]},"sales-rule-data-coupon-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\CouponInterface"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-rule-data-coupon-generation-spec-interface":{"type":"object","description":"CouponGenerationSpecInterface","properties":{"ruleId":{"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"},"delimiterAtEvery":{"type":"integer","description":"The spacing where the delimiter should exist"},"delimiter":{"type":"string","description":"The delimiter"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-extension-interface"}},"required":["ruleId","format","quantity","length"]},"sales-rule-data-coupon-generation-spec-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\CouponGenerationSpecInterface"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failedItems":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missingItems":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failedItems","missingItems"]},"tax-data-tax-rate-interface":{"type":"object","description":"Tax rate interface.","properties":{"id":{"type":"integer","description":"Id"},"taxCountryId":{"type":"string","description":"Country id"},"taxRegionId":{"type":"integer","description":"Region id"},"regionName":{"type":"string","description":"Region name"},"taxPostcode":{"type":"string","description":"Postcode"},"zipIsRange":{"type":"integer","description":"Zip is range"},"zipFrom":{"type":"integer","description":"Zip range from"},"zipTo":{"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"}},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rate-extension-interface"}},"required":["taxCountryId","rate","code"]},"tax-data-tax-rate-title-interface":{"type":"object","description":"Tax rate title interface.","properties":{"storeId":{"type":"string","description":"Store id"},"value":{"type":"string","description":"Title value"},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rate-title-extension-interface"}},"required":["storeId","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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"customerTaxClassIds":{"type":"array","description":"Customer tax class id","items":{"type":"integer"}},"productTaxClassIds":{"type":"array","description":"Product tax class id","items":{"type":"integer"}},"taxRateIds":{"type":"array","description":"Tax rate ids","items":{"type":"integer"}},"calculateSubtotal":{"type":"boolean","description":"Calculate subtotal."},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rule-extension-interface"}},"required":["code","priority","position","customerTaxClassIds","productTaxClassIds","taxRateIds"]},"tax-data-tax-rule-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxRuleInterface"},"tax-data-tax-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"tax-data-tax-class-interface":{"type":"object","description":"Tax class interface.","properties":{"classId":{"type":"integer","description":"Tax class ID."},"className":{"type":"string","description":"Tax class name."},"classType":{"type":"string","description":"Tax class type."},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-class-extension-interface"}},"required":["className","classType"]},"tax-data-tax-class-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxClassInterface"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]}}} diff --git a/src/swagger/schemas/2.0.10.schema.json b/src/swagger/schemas/2.0.10.schema.json deleted file mode 100644 index 985e40ef2f0..00000000000 --- a/src/swagger/schemas/2.0.10.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.0","title":"Magento Enterprise"},"host":"t2010.vg","basePath":"/rest/default","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":""},{"name":"searchV1","description":"Search API for all requests"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteGuestShipmentEstimationV1","description":"Interface GuestShipmentEstimationInterface"},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesShipOrderV1","description":"Class ShipOrderInterface"},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"salesInvoiceOrderV1","description":"Class InvoiceOrderInterface"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"customerBalanceBalanceManagementV1","description":"Customer balance(store credit) operations"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"giftCardAccountGiftCardAccountManagementV1","description":"Interface GiftCardAccountManagementInterface"},{"name":"giftCardAccountGuestGiftCardAccountManagementV1","description":""},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"},{"name":"giftRegistryShippingMethodManagementV1","description":""},{"name":"giftRegistryGuestCartShippingMethodManagementV1","description":""},{"name":"giftWrappingWrappingRepositoryV1","description":"Interface WrappingRepositoryInterface"},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"rewardRewardManagementV1","description":""},{"name":"rmaTrackManagementV1","description":"Interface TrackManagementInterface"},{"name":"rmaRmaRepositoryV1","description":"Interface RmaRepositoryInterface"},{"name":"rmaCommentManagementV1","description":"Interface CommentRepositoryInterface"},{"name":"rmaRmaManagementV1","description":"Interface RmaManagementInterface"},{"name":"rmaRmaAttributesManagementV1","description":"Interface RmaAttributesManagementInterface"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customer.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{id}":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customer.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","parameters":[{"name":"$body","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save custom option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save custom option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"$body","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/ship":{"post":{"tags":["salesShipOrderV1"],"description":"Creates new Shipment for given Order.","operationId":"salesShipOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Id of created Shipment."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/invoice":{"post":{"tags":["salesInvoiceOrderV1"],"description":"","operationId":"salesInvoiceOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/balance/apply":{"post":{"tags":["customerBalanceBalanceManagementV1"],"description":"Apply store credit","operationId":"customerBalanceBalanceManagementV1ApplyPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve coupon.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"$body","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"$body","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"$body","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/giftCards":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Return GiftCard Account cards","operationId":"giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards":{"put":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards":{"post":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards":{"post":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/giftregistry/mine/estimate-shipping-methods":{"post":{"tags":["giftRegistryShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":{"post":{"tags":["giftRegistryGuestCartShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{id}":{"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return data object for specified wrapping ID and store.","operationId":"giftWrappingWrappingRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Delete gift wrapping","operationId":"giftWrappingWrappingRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings":{"post":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return list of gift wrapping data objects based on search criteria","operationId":"giftWrappingWrappingRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{wrappingId}":{"put":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePut","parameters":[{"name":"wrappingId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/reward/mine/use-reward":{"post":{"tags":["rewardRewardManagementV1"],"description":"Set reward points to quote","operationId":"rewardRewardManagementV1SetPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers":{"post":{"tags":["rmaTrackManagementV1"],"description":"Add track","operationId":"rmaTrackManagementV1AddTrackPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["track"],"properties":{"track":{"$ref":"#/definitions/rma-data-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaTrackManagementV1"],"description":"Get track list","operationId":"rmaTrackManagementV1GetTracksGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-track-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers/{trackId}":{"delete":{"tags":["rmaTrackManagementV1"],"description":"Remove track by id","operationId":"rmaTrackManagementV1RemoveTrackByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"trackId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/labels":{"get":{"tags":["rmaTrackManagementV1"],"description":"Get shipping label int the PDF format","operationId":"rmaTrackManagementV1GetShippingLabelPdfGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}":{"get":{"tags":["rmaRmaRepositoryV1"],"description":"Return data object for specified RMA id","operationId":"rmaRmaRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["rmaRmaRepositoryV1"],"description":"Delete RMA","operationId":"rmaRmaRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/comments":{"post":{"tags":["rmaCommentManagementV1"],"description":"Add comment","operationId":"rmaCommentManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/rma-data-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaCommentManagementV1"],"description":"Comments list","operationId":"rmaCommentManagementV1CommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns":{"post":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPost","parameters":[{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaRmaManagementV1"],"description":"Return list of rma data objects based on search criteria","operationId":"rmaRmaManagementV1SearchGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/{attributeCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/form/{formCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve all attributes filtered by form code","operationId":"rmaRmaAttributesManagementV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get all attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/custom":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get custom attribute metadata for the given Data object's attribute set","operationId":"rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataObjectClassName","in":"query","type":"string","description":"Data object class name","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/framework-metadata-object-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"websiteId":{"type":"integer"},"storeGroupId":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","websiteId","storeGroupId"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"websiteId":{"type":"integer"},"rootCategoryId":{"type":"integer"},"defaultStoreId":{"type":"integer"},"name":{"type":"string"},"extensionAttributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","websiteId","rootCategoryId","defaultStoreId","name"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"defaultGroupId":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","defaultGroupId"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"websiteId":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"defaultDisplayCurrencyCode":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weightUnit":{"type":"string","description":"The unit of weight"},"baseUrl":{"type":"string","description":"Base URL for the store"},"baseLinkUrl":{"type":"string","description":"Base link URL for the store"},"baseStaticUrl":{"type":"string","description":"Base static URL for the store"},"baseMediaUrl":{"type":"string","description":"Base media URL for the store"},"secureBaseUrl":{"type":"string","description":"Secure base URL for the store"},"secureBaseLinkUrl":{"type":"string","description":"Secure base link URL for the store"},"secureBaseStaticUrl":{"type":"string","description":"Secure base static URL for the store"},"secureBaseMediaUrl":{"type":"string","description":"Secure base media URL for the store"},"extensionAttributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","websiteId","locale","baseCurrencyCode","defaultDisplayCurrencyCode","timezone","weightUnit","baseUrl","baseLinkUrl","baseStaticUrl","baseMediaUrl","secureBaseUrl","secureBaseLinkUrl","secureBaseStaticUrl","secureBaseMediaUrl"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"baseCurrencyCode":{"type":"string","description":"The base currency code for the store."},"baseCurrencySymbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"defaultDisplayCurrencyCode":{"type":"string","description":"The default display currency code for the store."},"defaultDisplayCurrencySymbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"availableCurrencyCodes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchangeRates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extensionAttributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["baseCurrencyCode","baseCurrencySymbol","defaultDisplayCurrencyCode","defaultDisplayCurrencySymbol","availableCurrencyCodes","exchangeRates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currencyTo":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extensionAttributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currencyTo","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"twoLetterAbbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"threeLetterAbbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"fullNameLocale":{"type":"string","description":"The country full name (in store locale) for the store."},"fullNameEnglish":{"type":"string","description":"The country full name (in English) for the store."},"availableRegions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extensionAttributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","twoLetterAbbreviation","threeLetterAbbreviation","fullNameLocale","fullNameEnglish"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extensionAttributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"eav-data-attribute-set-interface":{"type":"object","description":"","properties":{"attributeSetId":{"type":"integer","description":"Attribute set ID"},"attributeSetName":{"type":"string","description":"Attribute set name"},"sortOrder":{"type":"integer","description":"Attribute set sort order index"},"entityTypeId":{"type":"integer","description":"Attribute set entity type id"},"extensionAttributes":{"$ref":"#/definitions/eav-data-attribute-set-extension-interface"}},"required":["attributeSetName","sortOrder"]},"eav-data-attribute-set-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Eav\\Api\\Data\\AttributeSetInterface"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filterGroups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sortOrders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"pageSize":{"type":"integer","description":"Page size."},"currentPage":{"type":"integer","description":"Current page."}},"required":["filterGroups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"conditionType":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"customer-data-group-interface":{"type":"object","description":"Customer group interface.","properties":{"id":{"type":"integer","description":"Id"},"code":{"type":"string","description":"Code"},"taxClassId":{"type":"integer","description":"Tax class id"},"taxClassName":{"type":"string","description":"Tax class name"},"extensionAttributes":{"$ref":"#/definitions/customer-data-group-extension-interface"}},"required":["code","taxClassId"]},"customer-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\GroupInterface"},"customer-data-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontendInput":{"type":"string","description":"HTML for input element."},"inputFilter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"storeLabel":{"type":"string","description":"Label of the store."},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multilineCount":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"dataModel":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontendClass":{"type":"string","description":"Class which is used to display the attribute on frontend."},"userDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sortOrder":{"type":"integer","description":"Attributes sort order."},"frontendLabel":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backendType":{"type":"string","description":"Backend type."},"isUsedInGrid":{"type":"boolean","description":"It is used in customer grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in customer grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in customer grid"},"isSearchableInGrid":{"type":"boolean","description":"It is searchable in customer grid"},"attributeCode":{"type":"string","description":"Code of the attribute."}},"required":["frontendInput","inputFilter","storeLabel","validationRules","multilineCount","visible","required","dataModel","options","frontendClass","userDefined","sortOrder","frontendLabel","note","system","backendType","attributeCode"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"customer-data-customer-interface":{"type":"object","description":"Customer interface.","properties":{"id":{"type":"integer","description":"Customer id"},"groupId":{"type":"integer","description":"Group id"},"defaultBilling":{"type":"string","description":"Default billing address id"},"defaultShipping":{"type":"string","description":"Default shipping address id"},"confirmation":{"type":"string","description":"Confirmation"},"createdAt":{"type":"string","description":"Created at time"},"updatedAt":{"type":"string","description":"Updated at time"},"createdIn":{"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"},"storeId":{"type":"integer","description":"Store id"},"taxvat":{"type":"string","description":"Tax Vat"},"websiteId":{"type":"integer","description":"Website id"},"addresses":{"type":"array","description":"Customer addresses.","items":{"$ref":"#/definitions/customer-data-address-interface"}},"disableAutoGroupChange":{"type":"integer","description":"Disable auto group change flag."},"extensionAttributes":{"$ref":"#/definitions/customer-data-customer-extension-interface"},"customAttributes":{"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"},"customerId":{"type":"integer","description":"Customer ID"},"region":{"$ref":"#/definitions/customer-data-region-interface"},"regionId":{"type":"integer","description":"Region ID"},"countryId":{"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"},"vatId":{"type":"string","description":"Vat id"},"defaultShipping":{"type":"boolean","description":"If this address is default shipping address."},"defaultBilling":{"type":"boolean","description":"If this address is default billing address"},"extensionAttributes":{"$ref":"#/definitions/customer-data-address-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"customer-data-region-interface":{"type":"object","description":"Customer address region interface.","properties":{"regionCode":{"type":"string","description":"Region code"},"region":{"type":"string","description":"Region"},"regionId":{"type":"integer","description":"Region id"},"extensionAttributes":{"$ref":"#/definitions/customer-data-region-extension-interface"}},"required":["regionCode","region","regionId"]},"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":{"attributeCode":{"type":"string","description":"Attribute code"},"value":{"type":"string","description":"Attribute value"}},"required":["attributeCode","value"]},"customer-data-customer-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\CustomerInterface"},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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"},"pageLayout":{"type":"string","description":"Page layout"},"metaKeywords":{"type":"string","description":"Meta keywords"},"metaDescription":{"type":"string","description":"Meta description"},"contentHeading":{"type":"string","description":"Content heading"},"content":{"type":"string","description":"Content"},"creationTime":{"type":"string","description":"Creation time"},"updateTime":{"type":"string","description":"Update time"},"sortOrder":{"type":"string","description":"Sort order"},"layoutUpdateXml":{"type":"string","description":"Layout update xml"},"customTheme":{"type":"string","description":"Custom theme"},"customRootTemplate":{"type":"string","description":"Custom root template"},"customLayoutUpdateXml":{"type":"string","description":"Custom layout update xml"},"customThemeFrom":{"type":"string","description":"Custom theme from"},"customThemeTo":{"type":"string","description":"Custom theme to"},"active":{"type":"boolean","description":"Active"}},"required":["identifier"]},"cms-data-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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"},"creationTime":{"type":"string","description":"Creation time"},"updateTime":{"type":"string","description":"Update time"},"active":{"type":"boolean","description":"Active"}},"required":["identifier"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Id"},"sku":{"type":"string","description":"Sku"},"name":{"type":"string","description":"Name"},"attributeSetId":{"type":"integer","description":"Attribute set id"},"price":{"type":"number","description":"Price"},"status":{"type":"integer","description":"Status"},"visibility":{"type":"integer","description":"Visibility"},"typeId":{"type":"string","description":"Type id"},"createdAt":{"type":"string","description":"Created date"},"updatedAt":{"type":"string","description":"Updated date"},"weight":{"type":"number","description":"Weight"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-extension-interface"},"productLinks":{"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"}},"mediaGalleryEntries":{"type":"array","description":"Media gallery entries","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"tierPrices":{"type":"array","description":"List of product tier prices","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}},"customAttributes":{"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":{"downloadableProductLinks":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}},"downloadableProductSamples":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}},"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"giftcardAmounts":{"type":"array","items":{"$ref":"#/definitions/gift-card-data-giftcard-amount-interface"}},"configurableProductOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"configurableProductLinks":{"type":"array","items":{"type":"integer"}},"bundleProductOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}}},"downloadable-data-link-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Sample(or link) id"},"title":{"type":"string"},"sortOrder":{"type":"integer"},"isShareable":{"type":"integer","description":"Shareable status"},"price":{"type":"number","description":"Price"},"numberOfDownloads":{"type":"integer","description":"Of downloads per user"},"linkType":{"type":"string"},"linkFile":{"type":"string","description":"relative file path"},"linkFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"linkUrl":{"type":"string","description":"Link url or null when type is 'file'"},"sampleType":{"type":"string"},"sampleFile":{"type":"string","description":"relative file path"},"sampleFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"sampleUrl":{"type":"string","description":"file URL"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-link-extension-interface"}},"required":["sortOrder","isShareable","price","linkType","sampleType"]},"downloadable-data-file-content-interface":{"type":"object","description":"","properties":{"fileData":{"type":"string","description":"Data (base64 encoded content)"},"name":{"type":"string","description":"File name"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-file-content-extension-interface"}},"required":["fileData","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"},"sortOrder":{"type":"integer","description":"Order index for sample"},"sampleType":{"type":"string"},"sampleFile":{"type":"string","description":"relative file path"},"sampleFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"sampleUrl":{"type":"string","description":"file URL"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-sample-extension-interface"}},"required":["title","sortOrder","sampleType"]},"downloadable-data-sample-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Downloadable\\Api\\Data\\SampleInterface"},"catalog-inventory-data-stock-item-interface":{"type":"object","description":"Interface StockItem","properties":{"itemId":{"type":"integer"},"productId":{"type":"integer"},"stockId":{"type":"integer","description":"Stock identifier"},"qty":{"type":"number"},"isInStock":{"type":"boolean","description":"Stock Availability"},"isQtyDecimal":{"type":"boolean"},"showDefaultNotificationMessage":{"type":"boolean"},"useConfigMinQty":{"type":"boolean"},"minQty":{"type":"number","description":"Minimal quantity available for item status in stock"},"useConfigMinSaleQty":{"type":"integer"},"minSaleQty":{"type":"number","description":"Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation"},"useConfigMaxSaleQty":{"type":"boolean"},"maxSaleQty":{"type":"number","description":"Maximum Qty Allowed in Shopping Cart data wrapper"},"useConfigBackorders":{"type":"boolean"},"backorders":{"type":"integer","description":"Backorders status"},"useConfigNotifyStockQty":{"type":"boolean"},"notifyStockQty":{"type":"number","description":"Notify for Quantity Below data wrapper"},"useConfigQtyIncrements":{"type":"boolean"},"qtyIncrements":{"type":"number","description":"Quantity Increments data wrapper"},"useConfigEnableQtyInc":{"type":"boolean"},"enableQtyIncrements":{"type":"boolean","description":"Whether Quantity Increments is enabled"},"useConfigManageStock":{"type":"boolean"},"manageStock":{"type":"boolean","description":"Can Manage Stock"},"lowStockDate":{"type":"string"},"isDecimalDivided":{"type":"boolean"},"stockStatusChangedAuto":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/catalog-inventory-data-stock-item-extension-interface"}},"required":["qty","isInStock","isQtyDecimal","showDefaultNotificationMessage","useConfigMinQty","minQty","useConfigMinSaleQty","minSaleQty","useConfigMaxSaleQty","maxSaleQty","useConfigBackorders","backorders","useConfigNotifyStockQty","notifyStockQty","useConfigQtyIncrements","qtyIncrements","useConfigEnableQtyInc","enableQtyIncrements","useConfigManageStock","manageStock","lowStockDate","isDecimalDivided","stockStatusChangedAuto"]},"catalog-inventory-data-stock-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockItemInterface"},"gift-card-data-giftcard-amount-interface":{"type":"object","description":"Interface GiftcardAmountInterface: this interface is used to serialize and deserialize EAV attribute giftcard_amounts","properties":{"websiteId":{"type":"integer"},"value":{"type":"number"},"websiteValue":{"type":"number"},"extensionAttributes":{"$ref":"#/definitions/gift-card-data-giftcard-amount-extension-interface"}},"required":["websiteId","value","websiteValue"]},"gift-card-data-giftcard-amount-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCard\\Api\\Data\\GiftcardAmountInterface"},"configurable-product-data-option-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"attributeId":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"},"isUseDefault":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-value-interface"}},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-option-extension-interface"},"productId":{"type":"integer"}}},"configurable-product-data-option-value-interface":{"type":"object","description":"","properties":{"valueIndex":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-option-value-extension-interface"}},"required":["valueIndex"]},"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"},"bundle-data-option-interface":{"type":"object","description":"Interface OptionInterface","properties":{"optionId":{"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"},"productLinks":{"type":"array","description":"Product links","items":{"$ref":"#/definitions/bundle-data-link-interface"}},"extensionAttributes":{"$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"},"optionId":{"type":"integer","description":"Option id"},"qty":{"type":"number","description":"Qty"},"position":{"type":"integer","description":"Position"},"isDefault":{"type":"boolean","description":"Is default"},"price":{"type":"number","description":"Price"},"priceType":{"type":"integer","description":"Price type"},"canChangeQuantity":{"type":"integer","description":"Whether quantity could be changed"},"extensionAttributes":{"$ref":"#/definitions/bundle-data-link-extension-interface"}},"required":["isDefault","price","priceType"]},"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"},"catalog-data-product-link-interface":{"type":"object","description":"","properties":{"sku":{"type":"string","description":"SKU"},"linkType":{"type":"string","description":"Link type"},"linkedProductSku":{"type":"string","description":"Linked product sku"},"linkedProductType":{"type":"string","description":"Linked product type (simple, virtual, etc)"},"position":{"type":"integer","description":"Linked item position"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-extension-interface"}},"required":["sku","linkType","linkedProductSku","linkedProductType","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":{"productSku":{"type":"string","description":"Product SKU"},"optionId":{"type":"integer","description":"Option id"},"title":{"type":"string","description":"Option title"},"type":{"type":"string","description":"Option type"},"sortOrder":{"type":"integer","description":"Sort order"},"isRequire":{"type":"boolean","description":"Is require"},"price":{"type":"number","description":"Price"},"priceType":{"type":"string","description":"Price type"},"sku":{"type":"string","description":"Sku"},"fileExtension":{"type":"string"},"maxCharacters":{"type":"integer"},"imageSizeX":{"type":"integer"},"imageSizeY":{"type":"integer"},"values":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-values-interface"}},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-custom-option-extension-interface"}},"required":["productSku","title","type","sortOrder","isRequire"]},"catalog-data-product-custom-option-values-interface":{"type":"object","description":"","properties":{"title":{"type":"string","description":"Option title"},"sortOrder":{"type":"integer","description":"Sort order"},"price":{"type":"number","description":"Price"},"priceType":{"type":"string","description":"Price type"},"sku":{"type":"string","description":"Sku"},"optionTypeId":{"type":"integer","description":"Option type id"}},"required":["title","sortOrder","price","priceType"]},"catalog-data-product-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionInterface"},"catalog-data-product-attribute-media-gallery-entry-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Gallery entry ID"},"mediaType":{"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"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-extension-interface"}},"required":["mediaType","label","position","disabled","types"]},"framework-data-image-content-interface":{"type":"object","description":"Image Content data interface","properties":{"base64EncodedData":{"type":"string","description":"Media data (base64 encoded content)"},"type":{"type":"string","description":"MIME type"},"name":{"type":"string","description":"Image name"}},"required":["base64EncodedData","type","name"]},"catalog-data-product-attribute-media-gallery-entry-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeMediaGalleryEntryInterface","properties":{"videoContent":{"$ref":"#/definitions/framework-data-video-content-interface"}}},"framework-data-video-content-interface":{"type":"object","description":"Video Content data interface","properties":{"mediaType":{"type":"string","description":"MIME type"},"videoProvider":{"type":"string","description":"Provider"},"videoUrl":{"type":"string","description":"Video URL"},"videoTitle":{"type":"string","description":"Title"},"videoDescription":{"type":"string","description":"Video Description"},"videoMetadata":{"type":"string","description":"Metadata"}},"required":["mediaType","videoProvider","videoUrl","videoTitle","videoDescription","videoMetadata"]},"catalog-data-product-tier-price-interface":{"type":"object","description":"","properties":{"customerGroupId":{"type":"integer","description":"Customer group id"},"qty":{"type":"number","description":"Tier qty"},"value":{"type":"number","description":"Price value"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-tier-price-extension-interface"}},"required":["customerGroupId","qty","value"]},"catalog-data-product-tier-price-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTierPriceInterface"},"catalog-data-product-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"isWysiwygEnabled":{"type":"boolean","description":"WYSIWYG flag"},"isHtmlAllowedOnFront":{"type":"boolean","description":"The HTML tags are allowed on the frontend"},"usedForSortBy":{"type":"boolean","description":"It is used for sorting in product listing"},"isFilterable":{"type":"boolean","description":"It used in layered navigation"},"isFilterableInSearch":{"type":"boolean","description":"It is used in search results layered navigation"},"isUsedInGrid":{"type":"boolean","description":"It is used in catalog product grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in catalog product grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in catalog product grid"},"position":{"type":"integer","description":"Position"},"applyTo":{"type":"array","description":"Apply to value for the element","items":{"type":"string"}},"isSearchable":{"type":"string","description":"The attribute can be used in Quick Search"},"isVisibleInAdvancedSearch":{"type":"string","description":"The attribute can be used in Advanced Search"},"isComparable":{"type":"string","description":"The attribute can be compared on the frontend"},"isUsedForPromoRules":{"type":"string","description":"The attribute can be used for promo rules"},"isVisibleOnFront":{"type":"string","description":"The attribute is visible on the frontend"},"usedInProductListing":{"type":"string","description":"The attribute can be used in product listing"},"isVisible":{"type":"boolean","description":"Attribute is visible on frontend."},"scope":{"type":"string","description":"Attribute scope"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"attributeId":{"type":"integer","description":"Id of the attribute."},"attributeCode":{"type":"string","description":"Code of the attribute."},"frontendInput":{"type":"string","description":"HTML for input element."},"entityTypeId":{"type":"string","description":"Entity type id"},"isRequired":{"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"}},"isUserDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"defaultFrontendLabel":{"type":"string","description":"Frontend label for default store"},"frontendLabels":{"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."},"backendType":{"type":"string","description":"Backend type."},"backendModel":{"type":"string","description":"Backend model"},"sourceModel":{"type":"string","description":"Source model"},"defaultValue":{"type":"string","description":"Default value for the element."},"isUnique":{"type":"string","description":"This is a unique attribute"},"frontendClass":{"type":"string","description":"Frontend class of attribute"},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/eav-data-attribute-validation-rule-interface"}},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["attributeCode","frontendInput","isRequired","frontendLabels"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"eav-data-attribute-option-interface":{"type":"object","description":"Created from:","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"sortOrder":{"type":"integer","description":"Option order"},"isDefault":{"type":"boolean","description":"Default"},"storeLabels":{"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":"","properties":{"storeId":{"type":"integer","description":"Store id"},"label":{"type":"string","description":"Option label"}}},"eav-data-attribute-frontend-label-interface":{"type":"object","description":"","properties":{"storeId":{"type":"integer","description":"Store id"},"label":{"type":"string","description":"Option label"}}},"eav-data-attribute-validation-rule-interface":{"type":"object","description":"","properties":{"key":{"type":"string","description":"Object key"},"value":{"type":"string","description":"Object value"}},"required":["key","value"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"isWysiwygEnabled":{"type":"boolean","description":"WYSIWYG flag"},"isHtmlAllowedOnFront":{"type":"boolean","description":"The HTML tags are allowed on the frontend"},"usedForSortBy":{"type":"boolean","description":"It is used for sorting in product listing"},"isFilterable":{"type":"boolean","description":"It used in layered navigation"},"isFilterableInSearch":{"type":"boolean","description":"It is used in search results layered navigation"},"isUsedInGrid":{"type":"boolean","description":"It is used in catalog product grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in catalog product grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in catalog product grid"},"position":{"type":"integer","description":"Position"},"applyTo":{"type":"array","description":"Apply to value for the element","items":{"type":"string"}},"isSearchable":{"type":"string","description":"The attribute can be used in Quick Search"},"isVisibleInAdvancedSearch":{"type":"string","description":"The attribute can be used in Advanced Search"},"isComparable":{"type":"string","description":"The attribute can be compared on the frontend"},"isUsedForPromoRules":{"type":"string","description":"The attribute can be used for promo rules"},"isVisibleOnFront":{"type":"string","description":"The attribute is visible on the frontend"},"usedInProductListing":{"type":"string","description":"The attribute can be used in product listing"},"isVisible":{"type":"boolean","description":"Attribute is visible on frontend."},"scope":{"type":"string","description":"Attribute scope"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"attributeId":{"type":"integer","description":"Id of the attribute."},"attributeCode":{"type":"string","description":"Code of the attribute."},"frontendInput":{"type":"string","description":"HTML for input element."},"entityTypeId":{"type":"string","description":"Entity type id"},"isRequired":{"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"}},"isUserDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"defaultFrontendLabel":{"type":"string","description":"Frontend label for default store"},"frontendLabels":{"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."},"backendType":{"type":"string","description":"Backend type."},"backendModel":{"type":"string","description":"Backend model"},"sourceModel":{"type":"string","description":"Source model"},"defaultValue":{"type":"string","description":"Default value for the element."},"isUnique":{"type":"string","description":"This is a unique attribute"},"frontendClass":{"type":"string","description":"Frontend class of attribute"},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/eav-data-attribute-validation-rule-interface"}},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["attributeCode","frontendInput","isRequired","frontendLabels"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"eav-data-attribute-group-interface":{"type":"object","description":"","properties":{"attributeGroupId":{"type":"string","description":"Id"},"attributeGroupName":{"type":"string","description":"Name"},"attributeSetId":{"type":"integer","description":"Attribute set id"},"extensionAttributes":{"$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"},"catalog-data-category-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"parentId":{"type":"integer","description":"Parent category ID"},"name":{"type":"string","description":"Category name"},"isActive":{"type":"boolean","description":"Whether category is active"},"position":{"type":"integer","description":"Category position"},"level":{"type":"integer","description":"Category level"},"children":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"path":{"type":"string"},"availableSortBy":{"type":"array","items":{"type":"string"}},"includeInMenu":{"type":"boolean"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"parentId":{"type":"integer","description":"Parent category ID"},"name":{"type":"string","description":"Category name"},"isActive":{"type":"boolean","description":"Whether category is active"},"position":{"type":"integer","description":"Category position"},"level":{"type":"integer","description":"Category level"},"productCount":{"type":"integer","description":"Product count"},"childrenData":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parentId","name","isActive","position","level","productCount","childrenData"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"catalog-data-category-product-link-interface":{"type":"object","description":"","properties":{"sku":{"type":"string"},"position":{"type":"integer"},"categoryId":{"type":"string","description":"Category id"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-category-product-link-extension-interface"}},"required":["categoryId"]},"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"},"websiteId":{"type":"integer","description":"Website ids"}},"required":["sku","websiteId"]},"framework-search-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"searchCriteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","aggregations","searchCriteria","totalCount"]},"framework-search-document-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucketNames":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucketNames"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"","properties":{"requestName":{"type":"string"},"filterGroups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sortOrders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"pageSize":{"type":"integer","description":"Page size."},"currentPage":{"type":"integer","description":"Current page."}},"required":["requestName","filterGroups"]},"quote-data-cart-interface":{"type":"object","description":"Interface CartInterface","properties":{"id":{"type":"integer","description":"Cart/quote ID."},"createdAt":{"type":"string","description":"Cart creation date and time. Otherwise, null."},"updatedAt":{"type":"string","description":"Cart last update date and time. Otherwise, null."},"convertedAt":{"type":"string","description":"Cart conversion date and time. Otherwise, null."},"isActive":{"type":"boolean","description":"Active status flag value. Otherwise, null."},"isVirtual":{"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"}},"itemsCount":{"type":"integer","description":"Number of different items or products in the cart. Otherwise, null."},"itemsQty":{"type":"number","description":"Total quantity of all cart items. Otherwise, null."},"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"reservedOrderId":{"type":"integer","description":"Reserved order ID. Otherwise, null."},"origOrderId":{"type":"integer","description":"Original order ID. Otherwise, null."},"currency":{"$ref":"#/definitions/quote-data-currency-interface"},"customerIsGuest":{"type":"boolean","description":"For guest customers, false for logged in customers"},"customerNote":{"type":"string","description":"Notice text"},"customerNoteNotify":{"type":"boolean","description":"Customer notification flag"},"customerTaxClassId":{"type":"integer","description":"Customer tax class ID."},"storeId":{"type":"integer","description":"Store identifier"},"extensionAttributes":{"$ref":"#/definitions/quote-data-cart-extension-interface"}},"required":["id","customer","storeId"]},"quote-data-cart-item-interface":{"type":"object","description":"Interface CartItemInterface","properties":{"itemId":{"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."},"productType":{"type":"string","description":"Product type. Otherwise, null."},"quoteId":{"type":"string","description":"Quote id."},"productOption":{"$ref":"#/definitions/quote-data-product-option-interface"},"extensionAttributes":{"$ref":"#/definitions/quote-data-cart-item-extension-interface"}},"required":["qty","quoteId"]},"quote-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extensionAttributes":{"$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":{"customOptions":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"downloadableOption":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcardItemOption":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"},"configurableItemOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}},"bundleOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}}}},"catalog-data-custom-option-interface":{"type":"object","description":"Interface CustomOptionInterface","properties":{"optionId":{"type":"string","description":"Option id"},"optionValue":{"type":"string","description":"Option value"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-custom-option-extension-interface"}},"required":["optionId","optionValue"]},"catalog-data-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CustomOptionInterface","properties":{"fileInfo":{"$ref":"#/definitions/framework-data-image-content-interface"}}},"downloadable-data-downloadable-option-interface":{"type":"object","description":"Downloadable Option","properties":{"downloadableLinks":{"type":"array","description":"The list of downloadable links","items":{"type":"integer"}}},"required":["downloadableLinks"]},"gift-card-data-gift-card-option-interface":{"type":"object","description":"Interface GiftCardOptionInterface","properties":{"giftcardAmount":{"type":"number","description":"Gift card amount."},"customGiftcardAmount":{"type":"number","description":"Gift card open amount value."},"giftcardSenderName":{"type":"string","description":"Gift card sender name."},"giftcardRecipientName":{"type":"string","description":"Gift card recipient name."},"giftcardSenderEmail":{"type":"string","description":"Gift card sender email."},"giftcardRecipientEmail":{"type":"string","description":"Gift card recipient email."},"giftcardMessage":{"type":"string","description":"Giftcard message."},"extensionAttributes":{"$ref":"#/definitions/gift-card-data-gift-card-option-extension-interface"}},"required":["giftcardAmount","giftcardSenderName","giftcardRecipientName","giftcardSenderEmail","giftcardRecipientEmail"]},"gift-card-data-gift-card-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCard\\Api\\Data\\GiftCardOptionInterface"},"configurable-product-data-configurable-item-option-value-interface":{"type":"object","description":"Interface ConfigurableItemOptionValueInterface","properties":{"optionId":{"type":"string","description":"Option SKU"},"optionValue":{"type":"integer","description":"Item id"},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-extension-interface"}},"required":["optionId"]},"configurable-product-data-configurable-item-option-value-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\ConfigurableProduct\\Api\\Data\\ConfigurableItemOptionValueInterface"},"bundle-data-bundle-option-interface":{"type":"object","description":"Interface BundleOptionInterface","properties":{"optionId":{"type":"integer","description":"Bundle option id."},"optionQty":{"type":"integer","description":"Bundle option quantity."},"optionSelections":{"type":"array","description":"Bundle option selection ids.","items":{"type":"integer"}},"extensionAttributes":{"$ref":"#/definitions/bundle-data-bundle-option-extension-interface"}},"required":["optionId","optionQty","optionSelections"]},"bundle-data-bundle-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\BundleOptionInterface"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface"},"quote-data-address-interface":{"type":"object","description":"Interface AddressInterface","properties":{"id":{"type":"integer","description":"Id"},"region":{"type":"string","description":"Region name"},"regionId":{"type":"integer","description":"Region id"},"regionCode":{"type":"string","description":"Region code"},"countryId":{"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"},"vatId":{"type":"string","description":"Vat id"},"customerId":{"type":"integer","description":"Customer id"},"email":{"type":"string","description":"Billing/shipping email"},"sameAsBilling":{"type":"integer","description":"Same as billing flag"},"customerAddressId":{"type":"integer","description":"Customer address id"},"saveInAddressBook":{"type":"integer","description":"Save in address book flag"},"extensionAttributes":{"$ref":"#/definitions/quote-data-address-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["region","regionId","regionCode","countryId","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":{"giftRegistryId":{"type":"integer"}}},"quote-data-currency-interface":{"type":"object","description":"Interface CurrencyInterface","properties":{"globalCurrencyCode":{"type":"string","description":"Global currency code"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"storeCurrencyCode":{"type":"string","description":"Store currency code"},"quoteCurrencyCode":{"type":"string","description":"Quote currency code"},"storeToBaseRate":{"type":"number","description":"Store currency to base currency rate"},"storeToQuoteRate":{"type":"number","description":"Store currency to quote currency rate"},"baseToGlobalRate":{"type":"number","description":"Base currency to global currency rate"},"baseToQuoteRate":{"type":"number","description":"Base currency to quote currency rate"},"extensionAttributes":{"$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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"quote-data-payment-interface":{"type":"object","description":"Interface PaymentInterface","properties":{"poNumber":{"type":"string","description":"Purchase order number"},"method":{"type":"string","description":"Payment method code"},"additionalData":{"type":"array","description":"Payment additional details","items":{"type":"string"}},"extensionAttributes":{"$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":{"agreementIds":{"type":"array","items":{"type":"string"}}}},"quote-data-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrierCode":{"type":"string","description":"Shipping carrier code."},"methodCode":{"type":"string","description":"Shipping method code."},"carrierTitle":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"methodTitle":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"baseAmount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extensionAttributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"errorMessage":{"type":"string","description":"Shipping Error message."},"priceExclTax":{"type":"number","description":"Shipping price excl tax."},"priceInclTax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrierCode","methodCode","amount","baseAmount","available","errorMessage","priceExclTax","priceInclTax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grandTotal":{"type":"number","description":"Grand total in quote currency"},"baseGrandTotal":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"baseSubtotal":{"type":"number","description":"Subtotal in base currency"},"discountAmount":{"type":"number","description":"Discount amount in quote currency"},"baseDiscountAmount":{"type":"number","description":"Discount amount in base currency"},"subtotalWithDiscount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"baseSubtotalWithDiscount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shippingAmount":{"type":"number","description":"Shipping amount in quote currency"},"baseShippingAmount":{"type":"number","description":"Shipping amount in base currency"},"shippingDiscountAmount":{"type":"number","description":"Shipping discount amount in quote currency"},"baseShippingDiscountAmount":{"type":"number","description":"Shipping discount amount in base currency"},"taxAmount":{"type":"number","description":"Tax amount in quote currency"},"baseTaxAmount":{"type":"number","description":"Tax amount in base currency"},"weeeTaxAppliedAmount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount in quote currency"},"baseShippingTaxAmount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotalInclTax":{"type":"number","description":"Subtotal including tax in quote currency"},"baseSubtotalInclTax":{"type":"number","description":"Subtotal including tax in base currency"},"shippingInclTax":{"type":"number","description":"Shipping including tax in quote currency"},"baseShippingInclTax":{"type":"number","description":"Shipping including tax in base currency"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"quoteCurrencyCode":{"type":"string","description":"Quote currency code"},"couponCode":{"type":"string","description":"Applied coupon code"},"itemsQty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"totalSegments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weeeTaxAppliedAmount","totalSegments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"itemId":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"basePrice":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"rowTotal":{"type":"number","description":"Row total in quote currency."},"baseRowTotal":{"type":"number","description":"Row total in base currency."},"rowTotalWithDiscount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"taxAmount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"baseTaxAmount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"taxPercent":{"type":"number","description":"Tax percent. Otherwise, null."},"discountAmount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"baseDiscountAmount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discountPercent":{"type":"number","description":"Discount percent. Otherwise, null."},"priceInclTax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"basePriceInclTax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"rowTotalInclTax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"baseRowTotalInclTax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weeeTaxAppliedAmount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weeeTaxApplied":{"type":"string","description":"Item weee tax applied in quote currency."},"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["itemId","price","basePrice","qty","rowTotal","baseRowTotal","options","weeeTaxAppliedAmount","weeeTaxApplied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extensionAttributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"taxGrandtotalDetails":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}},"giftCards":{"type":"string"},"gwOrderId":{"type":"string"},"gwItemIds":{"type":"array","items":{"type":"string"}},"gwAllowGiftReceipt":{"type":"string"},"gwAddCard":{"type":"string"},"gwPrice":{"type":"string"},"gwBasePrice":{"type":"string"},"gwItemsPrice":{"type":"string"},"gwItemsBasePrice":{"type":"string"},"gwCardPrice":{"type":"string"},"gwCardBasePrice":{"type":"string"},"gwBaseTaxAmount":{"type":"string"},"gwTaxAmount":{"type":"string"},"gwItemsBaseTaxAmount":{"type":"string"},"gwItemsTaxAmount":{"type":"string"},"gwCardBaseTaxAmount":{"type":"string"},"gwCardTaxAmount":{"type":"string"},"gwPriceInclTax":{"type":"string"},"gwBasePriceInclTax":{"type":"string"},"gwCardPriceInclTax":{"type":"string"},"gwCardBasePriceInclTax":{"type":"string"},"gwItemsPriceInclTax":{"type":"string"},"gwItemsBasePriceInclTax":{"type":"string"}}},"tax-data-grand-total-details-interface":{"type":"object","description":"","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"groupId":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","groupId"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface","properties":{"rewardPointsBalance":{"type":"number"},"rewardCurrencyAmount":{"type":"number"},"baseRewardCurrencyAmount":{"type":"number"}}},"quote-data-totals-additional-data-interface":{"type":"object","description":"Additional data for totals collection.","properties":{"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-additional-data-extension-interface"},"customAttributes":{"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":{"giftMessages":{"type":"array","items":{"$ref":"#/definitions/gift-message-data-message-interface"}}}},"gift-message-data-message-interface":{"type":"object","description":"","properties":{"giftMessageId":{"type":"integer","description":"Gift message ID. Otherwise, null."},"customerId":{"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."},"extensionAttributes":{"$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":{"entityId":{"type":"string"},"entityType":{"type":"string"},"wrappingId":{"type":"integer"},"wrappingAllowGiftReceipt":{"type":"boolean"},"wrappingAddPrintedCard":{"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":{"adjustmentNegative":{"type":"number","description":"Negative adjustment value."},"adjustmentPositive":{"type":"number","description":"Positive adjustment value."},"appliedRuleIds":{"type":"string","description":"Applied rule IDs."},"baseAdjustmentNegative":{"type":"number","description":"Base negative adjustment value."},"baseAdjustmentPositive":{"type":"number","description":"Base positive adjustment value."},"baseCurrencyCode":{"type":"string","description":"Base currency code."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountCanceled":{"type":"number","description":"Base discount canceled."},"baseDiscountInvoiced":{"type":"number","description":"Base discount invoiced."},"baseDiscountRefunded":{"type":"number","description":"Base discount refunded."},"baseGrandTotal":{"type":"number","description":"Base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseDiscountTaxCompensationInvoiced":{"type":"number","description":"Base discount tax compensation invoiced."},"baseDiscountTaxCompensationRefunded":{"type":"number","description":"Base discount tax compensation refunded."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingCanceled":{"type":"number","description":"Base shipping canceled."},"baseShippingDiscountAmount":{"type":"number","description":"Base shipping discount amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Base shipping including tax."},"baseShippingInvoiced":{"type":"number","description":"Base shipping invoiced."},"baseShippingRefunded":{"type":"number","description":"Base shipping refunded."},"baseShippingTaxAmount":{"type":"number","description":"Base shipping tax amount."},"baseShippingTaxRefunded":{"type":"number","description":"Base shipping tax refunded."},"baseSubtotal":{"type":"number","description":"Base subtotal."},"baseSubtotalCanceled":{"type":"number","description":"Base subtotal canceled."},"baseSubtotalInclTax":{"type":"number","description":"Base subtotal including tax."},"baseSubtotalInvoiced":{"type":"number","description":"Base subtotal invoiced."},"baseSubtotalRefunded":{"type":"number","description":"Base subtotal refunded."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTaxCanceled":{"type":"number","description":"Base tax canceled."},"baseTaxInvoiced":{"type":"number","description":"Base tax invoiced."},"baseTaxRefunded":{"type":"number","description":"Base tax refunded."},"baseTotalCanceled":{"type":"number","description":"Base total canceled."},"baseTotalDue":{"type":"number","description":"Base total due."},"baseTotalInvoiced":{"type":"number","description":"Base total invoiced."},"baseTotalInvoicedCost":{"type":"number","description":"Base total invoiced cost."},"baseTotalOfflineRefunded":{"type":"number","description":"Base total offline refunded."},"baseTotalOnlineRefunded":{"type":"number","description":"Base total online refunded."},"baseTotalPaid":{"type":"number","description":"Base total paid."},"baseTotalQtyOrdered":{"type":"number","description":"Base total quantity ordered."},"baseTotalRefunded":{"type":"number","description":"Base total refunded."},"baseToGlobalRate":{"type":"number","description":"Base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Base-to-order rate."},"billingAddressId":{"type":"integer","description":"Billing address ID."},"canShipPartially":{"type":"integer","description":"Can-ship-partially flag value."},"canShipPartiallyItem":{"type":"integer","description":"Can-ship-partially-item flag value."},"couponCode":{"type":"string","description":"Coupon code."},"createdAt":{"type":"string","description":"Created-at timestamp."},"customerDob":{"type":"string","description":"Customer date-of-birth (DOB)."},"customerEmail":{"type":"string","description":"Customer email address."},"customerFirstname":{"type":"string","description":"Customer first name."},"customerGender":{"type":"integer","description":"Customer gender."},"customerGroupId":{"type":"integer","description":"Customer group ID."},"customerId":{"type":"integer","description":"Customer ID."},"customerIsGuest":{"type":"integer","description":"Customer-is-guest flag value."},"customerLastname":{"type":"string","description":"Customer last name."},"customerMiddlename":{"type":"string","description":"Customer middle name."},"customerNote":{"type":"string","description":"Customer note."},"customerNoteNotify":{"type":"integer","description":"Customer-note-notify flag value."},"customerPrefix":{"type":"string","description":"Customer prefix."},"customerSuffix":{"type":"string","description":"Customer suffix."},"customerTaxvat":{"type":"string","description":"Customer value-added tax (VAT)."},"discountAmount":{"type":"number","description":"Discount amount."},"discountCanceled":{"type":"number","description":"Discount canceled."},"discountDescription":{"type":"string","description":"Discount description."},"discountInvoiced":{"type":"number","description":"Discount invoiced."},"discountRefunded":{"type":"number","description":"Discount refunded amount."},"editIncrement":{"type":"integer","description":"Edit increment value."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Order ID."},"extCustomerId":{"type":"string","description":"External customer ID."},"extOrderId":{"type":"string","description":"External order ID."},"forcedShipmentWithInvoice":{"type":"integer","description":"Forced-shipment-with-invoice flag value."},"globalCurrencyCode":{"type":"string","description":"Global currency code."},"grandTotal":{"type":"number","description":"Grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"discountTaxCompensationInvoiced":{"type":"number","description":"Discount tax compensation invoiced amount."},"discountTaxCompensationRefunded":{"type":"number","description":"Discount tax compensation refunded amount."},"holdBeforeState":{"type":"string","description":"Hold before state."},"holdBeforeStatus":{"type":"string","description":"Hold before status."},"incrementId":{"type":"string","description":"Increment ID."},"isVirtual":{"type":"integer","description":"Is-virtual flag value."},"orderCurrencyCode":{"type":"string","description":"Order currency code."},"originalIncrementId":{"type":"string","description":"Original increment ID."},"paymentAuthorizationAmount":{"type":"number","description":"Payment authorization amount."},"paymentAuthExpiration":{"type":"integer","description":"Payment authorization expiration date."},"protectCode":{"type":"string","description":"Protect code."},"quoteAddressId":{"type":"integer","description":"Quote address ID."},"quoteId":{"type":"integer","description":"Quote ID."},"relationChildId":{"type":"string","description":"Relation child ID."},"relationChildRealId":{"type":"string","description":"Relation child real ID."},"relationParentId":{"type":"string","description":"Relation parent ID."},"relationParentRealId":{"type":"string","description":"Relation parent real ID."},"remoteIp":{"type":"string","description":"Remote IP address."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingCanceled":{"type":"number","description":"Shipping canceled amount."},"shippingDescription":{"type":"string","description":"Shipping description."},"shippingDiscountAmount":{"type":"number","description":"Shipping discount amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Shipping including tax amount."},"shippingInvoiced":{"type":"number","description":"Shipping invoiced amount."},"shippingRefunded":{"type":"number","description":"Shipping refunded amount."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount."},"shippingTaxRefunded":{"type":"number","description":"Shipping tax refunded amount."},"state":{"type":"string","description":"State."},"status":{"type":"string","description":"Status."},"storeCurrencyCode":{"type":"string","description":"Store currency code."},"storeId":{"type":"integer","description":"Store ID."},"storeName":{"type":"string","description":"Store name."},"storeToBaseRate":{"type":"number","description":"Store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Store-to-order rate."},"subtotal":{"type":"number","description":"Subtotal."},"subtotalCanceled":{"type":"number","description":"Subtotal canceled amount."},"subtotalInclTax":{"type":"number","description":"Subtotal including tax amount."},"subtotalInvoiced":{"type":"number","description":"Subtotal invoiced amount."},"subtotalRefunded":{"type":"number","description":"Subtotal refunded amount."},"taxAmount":{"type":"number","description":"Tax amount."},"taxCanceled":{"type":"number","description":"Tax canceled amount."},"taxInvoiced":{"type":"number","description":"Tax invoiced amount."},"taxRefunded":{"type":"number","description":"Tax refunded amount."},"totalCanceled":{"type":"number","description":"Total canceled."},"totalDue":{"type":"number","description":"Total due."},"totalInvoiced":{"type":"number","description":"Total invoiced amount."},"totalItemCount":{"type":"integer","description":"Total item count."},"totalOfflineRefunded":{"type":"number","description":"Total offline refunded amount."},"totalOnlineRefunded":{"type":"number","description":"Total online refunded amount."},"totalPaid":{"type":"number","description":"Total paid."},"totalQtyOrdered":{"type":"number","description":"Total quantity ordered."},"totalRefunded":{"type":"number","description":"Total amount refunded."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"xForwardedFor":{"type":"string","description":"X-Forwarded-For field value."},"items":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"billingAddress":{"$ref":"#/definitions/sales-data-order-address-interface"},"payment":{"$ref":"#/definitions/sales-data-order-payment-interface"},"statusHistories":{"type":"array","description":"Array of status histories.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-extension-interface"}},"required":["baseGrandTotal","customerEmail","grandTotal","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":{"additionalData":{"type":"string","description":"Additional data."},"amountRefunded":{"type":"number","description":"Amount refunded."},"appliedRuleIds":{"type":"string","description":"Applied rule IDs."},"baseAmountRefunded":{"type":"number","description":"Base amount refunded."},"baseCost":{"type":"number","description":"Base cost."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountInvoiced":{"type":"number","description":"Base discount invoiced."},"baseDiscountRefunded":{"type":"number","description":"Base discount refunded."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseDiscountTaxCompensationInvoiced":{"type":"number","description":"Base discount tax compensation invoiced."},"baseDiscountTaxCompensationRefunded":{"type":"number","description":"Base discount tax compensation refunded."},"baseOriginalPrice":{"type":"number","description":"Base original price."},"basePrice":{"type":"number","description":"Base price."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowInvoiced":{"type":"number","description":"Base row invoiced."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTaxBeforeDiscount":{"type":"number","description":"Base tax before discount."},"baseTaxInvoiced":{"type":"number","description":"Base tax invoiced."},"baseTaxRefunded":{"type":"number","description":"Base tax refunded."},"baseWeeeTaxAppliedAmount":{"type":"number","description":"Base WEEE tax applied amount."},"baseWeeeTaxAppliedRowAmnt":{"type":"number","description":"Base WEEE tax applied row amount."},"baseWeeeTaxDisposition":{"type":"number","description":"Base WEEE tax disposition."},"baseWeeeTaxRowDisposition":{"type":"number","description":"Base WEEE tax row disposition."},"createdAt":{"type":"string","description":"Created-at timestamp."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"discountInvoiced":{"type":"number","description":"Discount invoiced."},"discountPercent":{"type":"number","description":"Discount percent."},"discountRefunded":{"type":"number","description":"Discount refunded."},"eventId":{"type":"integer","description":"Event ID."},"extOrderItemId":{"type":"string","description":"External order item ID."},"freeShipping":{"type":"integer","description":"Free-shipping flag value."},"gwBasePrice":{"type":"number","description":"GW base price."},"gwBasePriceInvoiced":{"type":"number","description":"GW base price invoiced."},"gwBasePriceRefunded":{"type":"number","description":"GW base price refunded."},"gwBaseTaxAmount":{"type":"number","description":"GW base tax amount."},"gwBaseTaxAmountInvoiced":{"type":"number","description":"GW base tax amount invoiced."},"gwBaseTaxAmountRefunded":{"type":"number","description":"GW base tax amount refunded."},"gwId":{"type":"integer","description":"GW ID."},"gwPrice":{"type":"number","description":"GW price."},"gwPriceInvoiced":{"type":"number","description":"GW price invoiced."},"gwPriceRefunded":{"type":"number","description":"GW price refunded."},"gwTaxAmount":{"type":"number","description":"GW tax amount."},"gwTaxAmountInvoiced":{"type":"number","description":"GW tax amount invoiced."},"gwTaxAmountRefunded":{"type":"number","description":"GW tax amount refunded."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"discountTaxCompensationCanceled":{"type":"number","description":"Discount tax compensation canceled."},"discountTaxCompensationInvoiced":{"type":"number","description":"Discount tax compensation invoiced."},"discountTaxCompensationRefunded":{"type":"number","description":"Discount tax compensation refunded."},"isQtyDecimal":{"type":"integer","description":"Is-quantity-decimal flag value."},"isVirtual":{"type":"integer","description":"Is-virtual flag value."},"itemId":{"type":"integer","description":"Item ID."},"lockedDoInvoice":{"type":"integer","description":"Locked DO invoice flag value."},"lockedDoShip":{"type":"integer","description":"Locked DO ship flag value."},"name":{"type":"string","description":"Name."},"noDiscount":{"type":"integer","description":"No-discount flag value."},"orderId":{"type":"integer","description":"Order ID."},"originalPrice":{"type":"number","description":"Original price."},"parentItemId":{"type":"integer","description":"Parent item ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"productType":{"type":"string","description":"Product type."},"qtyBackordered":{"type":"number","description":"Quantity backordered."},"qtyCanceled":{"type":"number","description":"Quantity canceled."},"qtyInvoiced":{"type":"number","description":"Quantity invoiced."},"qtyOrdered":{"type":"number","description":"Quantity ordered."},"qtyRefunded":{"type":"number","description":"Quantity refunded."},"qtyReturned":{"type":"number","description":"Quantity returned."},"qtyShipped":{"type":"number","description":"Quantity shipped."},"quoteItemId":{"type":"integer","description":"Quote item ID."},"rowInvoiced":{"type":"number","description":"Row invoiced."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"rowWeight":{"type":"number","description":"Row weight."},"sku":{"type":"string","description":"SKU."},"storeId":{"type":"integer","description":"Store ID."},"taxAmount":{"type":"number","description":"Tax amount."},"taxBeforeDiscount":{"type":"number","description":"Tax before discount."},"taxCanceled":{"type":"number","description":"Tax canceled."},"taxInvoiced":{"type":"number","description":"Tax invoiced."},"taxPercent":{"type":"number","description":"Tax percent."},"taxRefunded":{"type":"number","description":"Tax refunded."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weeeTaxApplied":{"type":"string","description":"WEEE tax applied."},"weeeTaxAppliedAmount":{"type":"number","description":"WEEE tax applied amount."},"weeeTaxAppliedRowAmount":{"type":"number","description":"WEEE tax applied row amount."},"weeeTaxDisposition":{"type":"number","description":"WEEE tax disposition."},"weeeTaxRowDisposition":{"type":"number","description":"WEEE tax row disposition."},"weight":{"type":"number","description":"Weight."},"parentItem":{"$ref":"#/definitions/sales-data-order-item-interface"},"productOption":{"$ref":"#/definitions/catalog-data-product-option-interface"},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-item-extension-interface"}},"required":["sku"]},"catalog-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extensionAttributes":{"$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":{"customOptions":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"downloadableOption":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcardItemOption":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"},"configurableItemOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}},"bundleOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}}}},"sales-data-order-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderItemInterface","properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}}},"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":{"addressType":{"type":"string","description":"Address type."},"city":{"type":"string","description":"City."},"company":{"type":"string","description":"Company."},"countryId":{"type":"string","description":"Country ID."},"customerAddressId":{"type":"integer","description":"Country address ID."},"customerId":{"type":"integer","description":"Customer ID."},"email":{"type":"string","description":"Email address."},"entityId":{"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."},"parentId":{"type":"integer","description":"Parent ID."},"postcode":{"type":"string","description":"Postal code."},"prefix":{"type":"string","description":"Prefix."},"region":{"type":"string","description":"Region."},"regionCode":{"type":"string","description":"Region code."},"regionId":{"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."},"vatId":{"type":"string","description":"VAT ID."},"vatIsValid":{"type":"integer","description":"VAT-is-valid flag value."},"vatRequestDate":{"type":"string","description":"VAT request date."},"vatRequestId":{"type":"string","description":"VAT request ID."},"vatRequestSuccess":{"type":"integer","description":"VAT-request-success flag value."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-address-extension-interface"}},"required":["addressType","city","countryId","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":{"accountStatus":{"type":"string","description":"Account status."},"additionalData":{"type":"string","description":"Additional data."},"additionalInformation":{"type":"array","description":"Array of additional information.","items":{"type":"string"}},"addressStatus":{"type":"string","description":"Address status."},"amountAuthorized":{"type":"number","description":"Amount authorized."},"amountCanceled":{"type":"number","description":"Amount canceled."},"amountOrdered":{"type":"number","description":"Amount ordered."},"amountPaid":{"type":"number","description":"Amount paid."},"amountRefunded":{"type":"number","description":"Amount refunded."},"anetTransMethod":{"type":"string","description":"Anet transaction method."},"baseAmountAuthorized":{"type":"number","description":"Base amount authorized."},"baseAmountCanceled":{"type":"number","description":"Base amount canceled."},"baseAmountOrdered":{"type":"number","description":"Base amount ordered."},"baseAmountPaid":{"type":"number","description":"Base amount paid."},"baseAmountPaidOnline":{"type":"number","description":"Base amount paid online."},"baseAmountRefunded":{"type":"number","description":"Base amount refunded."},"baseAmountRefundedOnline":{"type":"number","description":"Base amount refunded online."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingCaptured":{"type":"number","description":"Base shipping captured amount."},"baseShippingRefunded":{"type":"number","description":"Base shipping refunded amount."},"ccApproval":{"type":"string","description":"Credit card approval."},"ccAvsStatus":{"type":"string","description":"Credit card avs status."},"ccCidStatus":{"type":"string","description":"Credit card CID status."},"ccDebugRequestBody":{"type":"string","description":"Credit card debug request body."},"ccDebugResponseBody":{"type":"string","description":"Credit card debug response body."},"ccDebugResponseSerialized":{"type":"string","description":"Credit card debug response serialized."},"ccExpMonth":{"type":"string","description":"Credit card expiration month."},"ccExpYear":{"type":"string","description":"Credit card expiration year."},"ccLast4":{"type":"string","description":"Last four digits of the credit card."},"ccNumberEnc":{"type":"string","description":"Encrypted credit card number."},"ccOwner":{"type":"string","description":"Credit card number."},"ccSecureVerify":{"type":"string","description":"Credit card secure verify."},"ccSsIssue":{"type":"string","description":"Credit card SS issue."},"ccSsStartMonth":{"type":"string","description":"Credit card SS start month."},"ccSsStartYear":{"type":"string","description":"Credit card SS start year."},"ccStatus":{"type":"string","description":"Credit card status."},"ccStatusDescription":{"type":"string","description":"Credit card status description."},"ccTransId":{"type":"string","description":"Credit card transaction ID."},"ccType":{"type":"string","description":"Credit card type."},"echeckAccountName":{"type":"string","description":"eCheck account name."},"echeckAccountType":{"type":"string","description":"eCheck account type."},"echeckBankName":{"type":"string","description":"eCheck bank name."},"echeckRoutingNumber":{"type":"string","description":"eCheck routing number."},"echeckType":{"type":"string","description":"eCheck type."},"entityId":{"type":"integer","description":"Entity ID."},"lastTransId":{"type":"string","description":"Last transaction ID."},"method":{"type":"string","description":"Method."},"parentId":{"type":"integer","description":"Parent ID."},"poNumber":{"type":"string","description":"PO number."},"protectionEligibility":{"type":"string","description":"Protection eligibility."},"quotePaymentId":{"type":"integer","description":"Quote payment ID."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingCaptured":{"type":"number","description":"Shipping captured."},"shippingRefunded":{"type":"number","description":"Shipping refunded."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-payment-extension-interface"}},"required":["accountStatus","additionalInformation","ccLast4","method"]},"sales-data-order-payment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderPaymentInterface"},"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."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Order status history ID."},"entityName":{"type":"string","description":"Entity name."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"status":{"type":"string","description":"Status."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-status-history-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"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":{"shippingAssignments":{"type":"array","items":{"$ref":"#/definitions/sales-data-shipping-assignment-interface"}},"appliedTaxes":{"type":"array","items":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-interface"}},"itemAppliedTaxes":{"type":"array","items":{"$ref":"#/definitions/tax-data-order-tax-details-item-interface"}},"convertingFromQuote":{"type":"boolean"},"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"},"gwId":{"type":"string"},"gwAllowGiftReceipt":{"type":"string"},"gwAddCard":{"type":"string"},"gwPrice":{"type":"string"},"gwBasePrice":{"type":"string"},"gwItemsPrice":{"type":"string"},"gwItemsBasePrice":{"type":"string"},"gwCardPrice":{"type":"string"},"gwCardBasePrice":{"type":"string"},"gwBaseTaxAmount":{"type":"string"},"gwTaxAmount":{"type":"string"},"gwItemsBaseTaxAmount":{"type":"string"},"gwItemsTaxAmount":{"type":"string"},"gwCardBaseTaxAmount":{"type":"string"},"gwCardTaxAmount":{"type":"string"},"gwPriceInclTax":{"type":"string"},"gwBasePriceInclTax":{"type":"string"},"gwCardPriceInclTax":{"type":"string"},"gwCardBasePriceInclTax":{"type":"string"},"gwItemsPriceInclTax":{"type":"string"},"gwItemsBasePriceInclTax":{"type":"string"}}},"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"}},"stockId":{"type":"integer","description":"Stock id"},"extensionAttributes":{"$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"},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipping-extension-interface"}}},"sales-data-total-interface":{"type":"object","description":"Interface TotalInterface","properties":{"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingCanceled":{"type":"number","description":"Base shipping canceled."},"baseShippingDiscountAmount":{"type":"number","description":"Base shipping discount amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Base shipping including tax."},"baseShippingInvoiced":{"type":"number","description":"Base shipping invoiced."},"baseShippingRefunded":{"type":"number","description":"Base shipping refunded."},"baseShippingTaxAmount":{"type":"number","description":"Base shipping tax amount."},"baseShippingTaxRefunded":{"type":"number","description":"Base shipping tax refunded."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingCanceled":{"type":"number","description":"Shipping canceled amount."},"shippingDiscountAmount":{"type":"number","description":"Shipping discount amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Shipping including tax amount."},"shippingInvoiced":{"type":"number","description":"Shipping invoiced amount."},"shippingRefunded":{"type":"number","description":"Shipping refunded amount."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount."},"shippingTaxRefunded":{"type":"number","description":"Shipping tax refunded amount."},"extensionAttributes":{"$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"},"tax-data-order-tax-details-applied-tax-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Title"},"percent":{"type":"number","description":"Tax Percent"},"amount":{"type":"number","description":"Tax amount"},"baseAmount":{"type":"number","description":"Tax amount in base currency"},"extensionAttributes":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-extension-interface"}},"required":["amount","baseAmount"]},"tax-data-order-tax-details-applied-tax-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\OrderTaxDetailsAppliedTaxInterface"},"tax-data-order-tax-details-item-interface":{"type":"object","description":"","properties":{"type":{"type":"string","description":"Type (shipping, product, weee, gift wrapping, etc)"},"itemId":{"type":"integer","description":"Item id if this item is a product"},"associatedItemId":{"type":"integer","description":"Associated item id if this item is associated with another item, null otherwise"},"appliedTaxes":{"type":"array","description":"Applied taxes","items":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-interface"}},"extensionAttributes":{"$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"},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-invoice-interface":{"type":"object","description":"Invoice interface. An invoice is a record of the receipt of payment for an order.","properties":{"baseCurrencyCode":{"type":"string","description":"Base currency code."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseGrandTotal":{"type":"number","description":"Base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Base shipping including tax."},"baseShippingTaxAmount":{"type":"number","description":"Base shipping tax amount."},"baseSubtotal":{"type":"number","description":"Base subtotal."},"baseSubtotalInclTax":{"type":"number","description":"Base subtotal including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTotalRefunded":{"type":"number","description":"Base total refunded."},"baseToGlobalRate":{"type":"number","description":"Base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Base-to-order rate."},"billingAddressId":{"type":"integer","description":"Billing address ID."},"canVoidFlag":{"type":"integer","description":"Can void flag value."},"createdAt":{"type":"string","description":"Created-at timestamp."},"discountAmount":{"type":"number","description":"Discount amount."},"discountDescription":{"type":"string","description":"Discount description."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Invoice ID."},"globalCurrencyCode":{"type":"string","description":"Global currency code."},"grandTotal":{"type":"number","description":"Grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"incrementId":{"type":"string","description":"Increment ID."},"isUsedForRefund":{"type":"integer","description":"Is-used-for-refund flag value."},"orderCurrencyCode":{"type":"string","description":"Order currency code."},"orderId":{"type":"integer","description":"Order ID."},"shippingAddressId":{"type":"integer","description":"Shipping address ID."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Shipping including tax."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount."},"state":{"type":"integer","description":"State."},"storeCurrencyCode":{"type":"string","description":"Store currency code."},"storeId":{"type":"integer","description":"Store ID."},"storeToBaseRate":{"type":"number","description":"Store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Store-to-order rate."},"subtotal":{"type":"number","description":"Subtotal."},"subtotalInclTax":{"type":"number","description":"Subtotal including tax."},"taxAmount":{"type":"number","description":"Tax amount."},"totalQty":{"type":"number","description":"Total quantity."},"transactionId":{"type":"string","description":"Transaction ID."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-extension-interface"}},"required":["orderId","totalQty","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":{"additionalData":{"type":"string","description":"Additional data."},"baseCost":{"type":"number","description":"Base cost."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"basePrice":{"type":"number","description":"Base price."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"entityId":{"type":"integer","description":"Invoice item ID."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"name":{"type":"string","description":"Name."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"sku":{"type":"string","description":"SKU."},"taxAmount":{"type":"number","description":"Tax amount."},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-item-extension-interface"},"orderItemId":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["sku","orderItemId","qty"]},"sales-data-invoice-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceItemInterface"},"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":{"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-comment-extension-interface"},"comment":{"type":"string","description":"Comment."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Invoice ID."}},"required":["isCustomerNotified","parentId","comment","isVisibleOnFront"]},"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"},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-creditmemo-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Credit memo ID."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-comment-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"sales-data-creditmemo-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoCommentInterface"},"sales-data-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"adjustmentNegative":{"type":"number","description":"Credit memo negative adjustment."},"adjustmentPositive":{"type":"number","description":"Credit memo positive adjustment."},"baseAdjustment":{"type":"number","description":"Credit memo base adjustment."},"baseAdjustmentNegative":{"type":"number","description":"Credit memo negative base adjustment."},"baseAdjustmentPositive":{"type":"number","description":"Credit memo positive base adjustment."},"baseCurrencyCode":{"type":"string","description":"Credit memo base currency code."},"baseDiscountAmount":{"type":"number","description":"Credit memo base discount amount."},"baseGrandTotal":{"type":"number","description":"Credit memo base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Credit memo base discount tax compensation amount."},"baseShippingAmount":{"type":"number","description":"Credit memo base shipping amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Credit memo base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Credit memo base shipping including tax."},"baseShippingTaxAmount":{"type":"number","description":"Credit memo base shipping tax amount."},"baseSubtotal":{"type":"number","description":"Credit memo base subtotal."},"baseSubtotalInclTax":{"type":"number","description":"Credit memo base subtotal including tax."},"baseTaxAmount":{"type":"number","description":"Credit memo base tax amount."},"baseToGlobalRate":{"type":"number","description":"Credit memo base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Credit memo base-to-order rate."},"billingAddressId":{"type":"integer","description":"Credit memo billing address ID."},"createdAt":{"type":"string","description":"Credit memo created-at timestamp."},"creditmemoStatus":{"type":"integer","description":"Credit memo status."},"discountAmount":{"type":"number","description":"Credit memo discount amount."},"discountDescription":{"type":"string","description":"Credit memo discount description."},"emailSent":{"type":"integer","description":"Credit memo email sent flag value."},"entityId":{"type":"integer","description":"Credit memo ID."},"globalCurrencyCode":{"type":"string","description":"Credit memo global currency code."},"grandTotal":{"type":"number","description":"Credit memo grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Credit memo discount tax compensation amount."},"incrementId":{"type":"string","description":"Credit memo increment ID."},"invoiceId":{"type":"integer","description":"Credit memo invoice ID."},"orderCurrencyCode":{"type":"string","description":"Credit memo order currency code."},"orderId":{"type":"integer","description":"Credit memo order ID."},"shippingAddressId":{"type":"integer","description":"Credit memo shipping address ID."},"shippingAmount":{"type":"number","description":"Credit memo shipping amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Credit memo shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Credit memo shipping including tax."},"shippingTaxAmount":{"type":"number","description":"Credit memo shipping tax amount."},"state":{"type":"integer","description":"Credit memo state."},"storeCurrencyCode":{"type":"string","description":"Credit memo store currency code."},"storeId":{"type":"integer","description":"Credit memo store ID."},"storeToBaseRate":{"type":"number","description":"Credit memo store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Credit memo store-to-order rate."},"subtotal":{"type":"number","description":"Credit memo subtotal."},"subtotalInclTax":{"type":"number","description":"Credit memo subtotal including tax."},"taxAmount":{"type":"number","description":"Credit memo tax amount."},"transactionId":{"type":"string","description":"Credit memo transaction ID."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-extension-interface"}},"required":["orderId","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":{"additionalData":{"type":"string","description":"Additional data."},"baseCost":{"type":"number","description":"The base cost for a credit memo item."},"baseDiscountAmount":{"type":"number","description":"The base discount amount for a credit memo item."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"The base discount tax compensation amount for a credit memo item."},"basePrice":{"type":"number","description":"The base price for a credit memo item."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseWeeeTaxAppliedAmount":{"type":"number","description":"Base WEEE tax applied amount."},"baseWeeeTaxAppliedRowAmnt":{"type":"number","description":"Base WEEE tax applied row amount."},"baseWeeeTaxDisposition":{"type":"number","description":"Base WEEE tax disposition."},"baseWeeeTaxRowDisposition":{"type":"number","description":"Base WEEE tax row disposition."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"entityId":{"type":"integer","description":"Credit memo item ID."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"name":{"type":"string","description":"Name."},"orderItemId":{"type":"integer","description":"Order item ID."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"qty":{"type":"number","description":"Quantity."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"sku":{"type":"string","description":"SKU."},"taxAmount":{"type":"number","description":"Tax amount."},"weeeTaxApplied":{"type":"string","description":"WEEE tax applied."},"weeeTaxAppliedAmount":{"type":"number","description":"WEEE tax applied amount."},"weeeTaxAppliedRowAmount":{"type":"number","description":"WEEE tax applied row amount."},"weeeTaxDisposition":{"type":"number","description":"WEEE tax disposition."},"weeeTaxRowDisposition":{"type":"number","description":"WEEE tax row disposition."},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-item-extension-interface"}},"required":["baseCost","basePrice","entityId","orderItemId","qty"]},"sales-data-creditmemo-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoItemInterface"},"sales-data-creditmemo-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoInterface"},"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":{"billingAddressId":{"type":"integer","description":"Billing address ID."},"createdAt":{"type":"string","description":"Created-at timestamp."},"customerId":{"type":"integer","description":"Customer ID."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Shipment ID."},"incrementId":{"type":"string","description":"Increment ID."},"orderId":{"type":"integer","description":"Order ID."},"packages":{"type":"array","description":"Array of packages, if any. Otherwise, null.","items":{"$ref":"#/definitions/sales-data-shipment-package-interface"}},"shipmentStatus":{"type":"integer","description":"Shipment status."},"shippingAddressId":{"type":"integer","description":"Shipping address ID."},"shippingLabel":{"type":"string","description":"Shipping label."},"storeId":{"type":"integer","description":"Store ID."},"totalQty":{"type":"number","description":"Total quantity."},"totalWeight":{"type":"number","description":"Total weight."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-extension-interface"}},"required":["orderId","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":{"extensionAttributes":{"$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":{"additionalData":{"type":"string","description":"Additional data."},"description":{"type":"string","description":"Description."},"entityId":{"type":"integer","description":"Shipment item ID."},"name":{"type":"string","description":"Name."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"productId":{"type":"integer","description":"Product ID."},"rowTotal":{"type":"number","description":"Row total."},"sku":{"type":"string","description":"SKU."},"weight":{"type":"number","description":"Weight."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-item-extension-interface"},"orderItemId":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["orderItemId","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":{"orderId":{"type":"integer","description":"The order_id for the shipment package."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Shipment package ID."},"parentId":{"type":"integer","description":"Parent ID."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"qty":{"type":"number","description":"Quantity."},"description":{"type":"string","description":"Description."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-track-extension-interface"},"trackNumber":{"type":"string","description":"Track number."},"title":{"type":"string","description":"Title."},"carrierCode":{"type":"string","description":"Carrier code."}},"required":["orderId","parentId","weight","qty","description","trackNumber","title","carrierCode"]},"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":{"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-comment-extension-interface"},"comment":{"type":"string","description":"Comment."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Invoice ID."}},"required":["isCustomerNotified","parentId","comment","isVisibleOnFront"]},"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"},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-shipment-item-creation-interface":{"type":"object","description":"Input argument for shipment item creation Interface ShipmentItemCreationInterface","properties":{"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-item-creation-extension-interface"},"orderItemId":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["orderItemId","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":{"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-comment-creation-extension-interface"},"comment":{"type":"string","description":"Comment."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."}},"required":["comment","isVisibleOnFront"]},"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":{"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-track-creation-extension-interface"},"trackNumber":{"type":"string","description":"Track number."},"title":{"type":"string","description":"Title."},"carrierCode":{"type":"string","description":"Carrier code."}},"required":["trackNumber","title","carrierCode"]},"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":{"extensionAttributes":{"$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":{"extensionAttributes":{"$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"},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transactionId":{"type":"integer","description":"Transaction ID."},"parentId":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"orderId":{"type":"integer","description":"Order ID."},"paymentId":{"type":"integer","description":"Payment ID."},"txnId":{"type":"string","description":"Transaction business ID."},"parentTxnId":{"type":"string","description":"Parent transaction business ID."},"txnType":{"type":"string","description":"Transaction type."},"isClosed":{"type":"integer","description":"Is-closed flag value."},"additionalInformation":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"createdAt":{"type":"string","description":"Created-at timestamp."},"childTransactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transactionId","orderId","paymentId","txnId","parentTxnId","txnType","isClosed","createdAt","childTransactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-invoice-item-creation-interface":{"type":"object","description":"Input argument for invoice creation Interface InvoiceItemCreationInterface","properties":{"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-item-creation-extension-interface"},"orderItemId":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["orderItemId","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":{"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-comment-creation-extension-interface"},"comment":{"type":"string","description":"Comment."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."}},"required":["comment","isVisibleOnFront"]},"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":{"extensionAttributes":{"$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"},"catalog-inventory-data-stock-status-collection-interface":{"type":"object","description":"Stock Status collection interface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"searchCriteria":{"$ref":"#/definitions/catalog-inventory-stock-status-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"productId":{"type":"integer"},"stockId":{"type":"integer"},"qty":{"type":"integer"},"stockStatus":{"type":"integer"},"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extensionAttributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["productId","stockId","qty","stockStatus","stockItem"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"catalog-inventory-stock-status-criteria-interface":{"type":"object","description":"Interface StockStatusCriteriaInterface","properties":{"mapperInterfaceName":{"type":"string","description":"Associated Mapper Interface name"},"criteriaList":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapperInterfaceName","criteriaList","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapperInterfaceName":{"type":"string","description":"Associated Mapper Interface name"},"criteriaList":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapperInterfaceName","criteriaList","filters","orders","limit"]},"checkout-agreements-data-agreement-interface":{"type":"object","description":"","properties":{"agreementId":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"contentHeight":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkboxText":{"type":"string","description":"Agreement checkbox text."},"isActive":{"type":"boolean","description":"Agreement status."},"isHtml":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extensionAttributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreementId","name","content","checkboxText","isActive","isHtml","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"checkout-data-shipping-information-interface":{"type":"object","description":"","properties":{"shippingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"shippingMethodCode":{"type":"string","description":"Shipping method code"},"shippingCarrierCode":{"type":"string","description":"Carrier code"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-shipping-information-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["shippingAddress","shippingMethodCode","shippingCarrierCode"]},"checkout-data-shipping-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\ShippingInformationInterface"},"checkout-data-payment-details-interface":{"type":"object","description":"","properties":{"paymentMethods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["paymentMethods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"checkout-data-totals-information-interface":{"type":"object","description":"","properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"shippingMethodCode":{"type":"string","description":"Shipping method code"},"shippingCarrierCode":{"type":"string","description":"Carrier code"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-totals-information-extension-interface"},"customAttributes":{"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"},"tax-data-tax-rate-interface":{"type":"object","description":"Tax rate interface.","properties":{"id":{"type":"integer","description":"Id"},"taxCountryId":{"type":"string","description":"Country id"},"taxRegionId":{"type":"integer","description":"Region id"},"regionName":{"type":"string","description":"Region name"},"taxPostcode":{"type":"string","description":"Postcode"},"zipIsRange":{"type":"integer","description":"Zip is range"},"zipFrom":{"type":"integer","description":"Zip range from"},"zipTo":{"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"}},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rate-extension-interface"}},"required":["taxCountryId","rate","code"]},"tax-data-tax-rate-title-interface":{"type":"object","description":"Tax rate title interface.","properties":{"storeId":{"type":"string","description":"Store id"},"value":{"type":"string","description":"Title value"},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rate-title-extension-interface"}},"required":["storeId","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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"customerTaxClassIds":{"type":"array","description":"Customer tax class id","items":{"type":"integer"}},"productTaxClassIds":{"type":"array","description":"Product tax class id","items":{"type":"integer"}},"taxRateIds":{"type":"array","description":"Tax rate ids","items":{"type":"integer"}},"calculateSubtotal":{"type":"boolean","description":"Calculate subtotal."},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rule-extension-interface"}},"required":["code","priority","position","customerTaxClassIds","productTaxClassIds","taxRateIds"]},"tax-data-tax-rule-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxRuleInterface"},"tax-data-tax-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"tax-data-tax-class-interface":{"type":"object","description":"Tax class interface.","properties":{"classId":{"type":"integer","description":"Tax class ID."},"className":{"type":"string","description":"Tax class name."},"classType":{"type":"string","description":"Tax class type."},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-class-extension-interface"}},"required":["className","classType"]},"tax-data-tax-class-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxClassInterface"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-rule-data-rule-interface":{"type":"object","description":"Interface RuleInterface","properties":{"ruleId":{"type":"integer","description":"Rule id"},"name":{"type":"string","description":"Rule name"},"storeLabels":{"type":"array","description":"Display label","items":{"$ref":"#/definitions/sales-rule-data-rule-label-interface"}},"description":{"type":"string","description":"Description"},"websiteIds":{"type":"array","description":"A list of websites the rule applies to","items":{"type":"integer"}},"customerGroupIds":{"type":"array","description":"Ids of customer groups that the rule applies to","items":{"type":"integer"}},"fromDate":{"type":"string","description":"The start date when the coupon is active"},"toDate":{"type":"string","description":"The end date when the coupon is active"},"usesPerCustomer":{"type":"integer","description":"Number of uses per customer"},"isActive":{"type":"boolean","description":"The coupon is active"},"condition":{"$ref":"#/definitions/sales-rule-data-condition-interface"},"actionCondition":{"$ref":"#/definitions/sales-rule-data-condition-interface"},"stopRulesProcessing":{"type":"boolean","description":"To stop rule processing"},"isAdvanced":{"type":"boolean","description":"Is this field needed"},"productIds":{"type":"array","description":"Product ids","items":{"type":"integer"}},"sortOrder":{"type":"integer","description":"Sort order"},"simpleAction":{"type":"string","description":"Simple action of the rule"},"discountAmount":{"type":"number","description":"Discount amount"},"discountQty":{"type":"number","description":"Maximum qty discount is applied"},"discountStep":{"type":"integer","description":"Discount step"},"applyToShipping":{"type":"boolean","description":"The rule applies to shipping"},"timesUsed":{"type":"integer","description":"How many times the rule has been used"},"isRss":{"type":"boolean","description":"Whether the rule is in RSS"},"couponType":{"type":"string","description":"Coupon type"},"useAutoGeneration":{"type":"boolean","description":"To auto generate coupon"},"usesPerCoupon":{"type":"integer","description":"Limit of uses per coupon"},"simpleFreeShipping":{"type":"string","description":"To grant free shipping"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-rule-extension-interface"}},"required":["websiteIds","customerGroupIds","usesPerCustomer","isActive","stopRulesProcessing","isAdvanced","sortOrder","discountAmount","discountStep","applyToShipping","timesUsed","isRss","couponType","useAutoGeneration","usesPerCoupon"]},"sales-rule-data-rule-label-interface":{"type":"object","description":"Interface RuleLabelInterface","properties":{"storeId":{"type":"integer","description":"StoreId"},"storeLabel":{"type":"string","description":"The label for the store"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-rule-label-extension-interface"}},"required":["storeId","storeLabel"]},"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":{"conditionType":{"type":"string","description":"Condition type"},"conditions":{"type":"array","description":"List of conditions","items":{"$ref":"#/definitions/sales-rule-data-condition-interface"}},"aggregatorType":{"type":"string","description":"The aggregator type"},"operator":{"type":"string","description":"The operator of the condition"},"attributeName":{"type":"string","description":"The attribute name of the condition"},"value":{"type":"string","description":"The value of the condition"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-condition-extension-interface"}},"required":["conditionType","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":{"rewardPointsDelta":{"type":"integer"}}},"sales-rule-data-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-rule-data-coupon-interface":{"type":"object","description":"Interface CouponInterface","properties":{"couponId":{"type":"integer","description":"Coupon id"},"ruleId":{"type":"integer","description":"The id of the rule associated with the coupon"},"code":{"type":"string","description":"Coupon code"},"usageLimit":{"type":"integer","description":"Usage limit"},"usagePerCustomer":{"type":"integer","description":"Usage limit per customer"},"timesUsed":{"type":"integer","description":"The number of times the coupon has been used"},"expirationDate":{"type":"string","description":"Expiration date"},"isPrimary":{"type":"boolean","description":"The coupon is primary coupon for the rule that it's associated with"},"createdAt":{"type":"string","description":"When the coupon is created"},"type":{"type":"integer","description":"Of coupon"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-coupon-extension-interface"}},"required":["ruleId","timesUsed","isPrimary"]},"sales-rule-data-coupon-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\CouponInterface"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-rule-data-coupon-generation-spec-interface":{"type":"object","description":"CouponGenerationSpecInterface","properties":{"ruleId":{"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"},"delimiterAtEvery":{"type":"integer","description":"The spacing where the delimiter should exist"},"delimiter":{"type":"string","description":"The delimiter"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-extension-interface"}},"required":["ruleId","format","quantity","length"]},"sales-rule-data-coupon-generation-spec-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\CouponGenerationSpecInterface"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failedItems":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missingItems":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failedItems","missingItems"]},"gift-card-account-data-gift-card-account-interface":{"type":"object","description":"Gift Card Account data","properties":{"giftCards":{"type":"array","description":"Cards codes","items":{"type":"string"}},"giftCardsAmount":{"type":"number","description":"Cards amount in quote currency"},"baseGiftCardsAmount":{"type":"number","description":"Cards amount in base currency"},"giftCardsAmountUsed":{"type":"number","description":"Cards amount used in quote currency"},"baseGiftCardsAmountUsed":{"type":"number","description":"Cards amount used in base currency"},"extensionAttributes":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-extension-interface"}},"required":["giftCards","giftCardsAmount","baseGiftCardsAmount","giftCardsAmountUsed","baseGiftCardsAmountUsed"]},"gift-card-account-data-gift-card-account-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCardAccount\\Api\\Data\\GiftCardAccountInterface"},"gift-wrapping-data-wrapping-interface":{"type":"object","description":"","properties":{"wrappingId":{"type":"integer"},"design":{"type":"string"},"status":{"type":"integer"},"basePrice":{"type":"number"},"imageName":{"type":"string"},"imageBase64Content":{"type":"string"},"baseCurrencyCode":{"type":"string"},"websiteIds":{"type":"array","items":{"type":"integer"}},"imageUrl":{"type":"string","description":"Wrapping image URL."},"extensionAttributes":{"$ref":"#/definitions/gift-wrapping-data-wrapping-extension-interface"}},"required":["design","status","basePrice"]},"gift-wrapping-data-wrapping-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftWrapping\\Api\\Data\\WrappingInterface"},"gift-wrapping-data-wrapping-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extensionAttributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"rma-data-track-interface":{"type":"object","description":"Interface TrackInterface","properties":{"entityId":{"type":"integer","description":"Entity id"},"rmaEntityId":{"type":"integer","description":"Rma entity id"},"trackNumber":{"type":"string","description":"Track number"},"carrierTitle":{"type":"string","description":"Carrier title"},"carrierCode":{"type":"string","description":"Carrier code"},"extensionAttributes":{"$ref":"#/definitions/rma-data-track-extension-interface"}},"required":["entityId","rmaEntityId","trackNumber","carrierTitle","carrierCode"]},"rma-data-track-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Rma\\Api\\Data\\TrackInterface"},"rma-data-track-search-result-interface":{"type":"object","description":"Interface TrackSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-track-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"rma-data-rma-interface":{"type":"object","description":"Interface RmaInterface","properties":{"incrementId":{"type":"string","description":"Entity_id"},"entityId":{"type":"integer","description":"Entity_id"},"orderId":{"type":"integer","description":"Order_id"},"orderIncrementId":{"type":"string","description":"Order_increment_id"},"storeId":{"type":"integer","description":"Store_id"},"customerId":{"type":"integer","description":"Customer_id"},"dateRequested":{"type":"string","description":"Date_requested"},"customerCustomEmail":{"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"}},"extensionAttributes":{"$ref":"#/definitions/rma-data-rma-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["incrementId","entityId","orderId","orderIncrementId","storeId","customerId","dateRequested","customerCustomEmail","items","status","comments","tracks"]},"rma-data-item-interface":{"type":"object","description":"Interface CategoryInterface","properties":{"entityId":{"type":"integer","description":"Id"},"rmaEntityId":{"type":"integer","description":"RMA id"},"orderItemId":{"type":"integer","description":"Order_item_id"},"qtyRequested":{"type":"integer","description":"Qty_requested"},"qtyAuthorized":{"type":"integer","description":"Qty_authorized"},"qtyApproved":{"type":"integer","description":"Qty_approved"},"qtyReturned":{"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"},"extensionAttributes":{"$ref":"#/definitions/rma-data-item-extension-interface"}},"required":["entityId","rmaEntityId","orderItemId","qtyRequested","qtyAuthorized","qtyApproved","qtyReturned","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"},"rmaEntityId":{"type":"integer","description":"Rma Id"},"createdAt":{"type":"string","description":"Created_at"},"entityId":{"type":"integer","description":"Entity_id"},"customerNotified":{"type":"boolean","description":"Is_customer_notified"},"visibleOnFront":{"type":"boolean","description":"Is_visible_on_front"},"status":{"type":"string","description":"Status"},"admin":{"type":"boolean","description":"Is_admin"},"extensionAttributes":{"$ref":"#/definitions/rma-data-comment-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["comment","rmaEntityId","createdAt","entityId","customerNotified","visibleOnFront","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"},"rma-data-comment-search-result-interface":{"type":"object","description":"Interface CommentSearchResultInterface","properties":{"items":{"type":"array","description":"Rma Status History list","items":{"$ref":"#/definitions/rma-data-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"rma-data-rma-search-result-interface":{"type":"object","description":"Interface RmaSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-rma-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"framework-metadata-object-interface":{"type":"object","description":"Provides metadata about an attribute.","properties":{"attributeCode":{"type":"string","description":"Code of the attribute."}},"required":["attributeCode"]}}} diff --git a/src/swagger/schemas/2.1.2.schema.json b/src/swagger/schemas/2.1.2.schema.json deleted file mode 100644 index 8341e6d660c..00000000000 --- a/src/swagger/schemas/2.1.2.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.1","title":"Magento Community"},"host":"m2010.vg","basePath":"/rest/default","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":"Interface ProductWebsiteLinkRepositoryInterface"},{"name":"searchV1","description":"Search API for all requests"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteGuestShipmentEstimationV1","description":"Interface GuestShipmentEstimationInterface"},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesShipOrderV1","description":"Class ShipOrderInterface"},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"salesInvoiceOrderV1","description":"Class InvoiceOrderInterface"},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{id}":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","parameters":[{"name":"$body","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"put":{"tags":["quoteCartRepositoryV1"],"description":"Save quote","operationId":"quoteCartRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/items":{"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/create":{"put":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/":{"post":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"$body","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/refund":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Prepare creditmemo to refund and save it.","operationId":"salesCreditmemoManagementV1RefundPost","parameters":[{"name":"$body","in":"body","schema":{"required":["creditmemo"],"properties":{"creditmemo":{"$ref":"#/definitions/sales-data-creditmemo-interface"},"offlineRequested":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/ship":{"post":{"tags":["salesShipOrderV1"],"description":"Creates new Shipment for given Order.","operationId":"salesShipOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Id of created Shipment."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/invoice":{"post":{"tags":["salesInvoiceOrderV1"],"description":"","operationId":"salesInvoiceOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Configurable product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"$body","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"$body","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"$body","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"website_id":{"type":"integer"},"store_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","website_id","store_group_id"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"website_id":{"type":"integer"},"root_category_id":{"type":"integer"},"default_store_id":{"type":"integer"},"name":{"type":"string"},"extension_attributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","website_id","root_category_id","default_store_id","name"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"default_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","default_group_id"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"website_id":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"base_currency_code":{"type":"string","description":"Base currency code"},"default_display_currency_code":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weight_unit":{"type":"string","description":"The unit of weight"},"base_url":{"type":"string","description":"Base URL for the store"},"base_link_url":{"type":"string","description":"Base link URL for the store"},"base_static_url":{"type":"string","description":"Base static URL for the store"},"base_media_url":{"type":"string","description":"Base media URL for the store"},"secure_base_url":{"type":"string","description":"Secure base URL for the store"},"secure_base_link_url":{"type":"string","description":"Secure base link URL for the store"},"secure_base_static_url":{"type":"string","description":"Secure base static URL for the store"},"secure_base_media_url":{"type":"string","description":"Secure base media URL for the store"},"extension_attributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","website_id","locale","base_currency_code","default_display_currency_code","timezone","weight_unit","base_url","base_link_url","base_static_url","base_media_url","secure_base_url","secure_base_link_url","secure_base_static_url","secure_base_media_url"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"base_currency_code":{"type":"string","description":"The base currency code for the store."},"base_currency_symbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"default_display_currency_code":{"type":"string","description":"The default display currency code for the store."},"default_display_currency_symbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"available_currency_codes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchange_rates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["base_currency_code","base_currency_symbol","default_display_currency_code","default_display_currency_symbol","available_currency_codes","exchange_rates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currency_to":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extension_attributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currency_to","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"two_letter_abbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"three_letter_abbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"full_name_locale":{"type":"string","description":"The country full name (in store locale) for the store."},"full_name_english":{"type":"string","description":"The country full name (in English) for the store."},"available_regions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","two_letter_abbreviation","three_letter_abbreviation","full_name_locale","full_name_english"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extension_attributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"Interface AttributeSetSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["filter_groups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"condition_type":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"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-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontend_input":{"type":"string","description":"HTML for input element."},"input_filter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"store_label":{"type":"string","description":"Label of the store."},"validation_rules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multiline_count":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"data_model":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontend_class":{"type":"string","description":"Class which is used to display the attribute on frontend."},"user_defined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sort_order":{"type":"integer","description":"Attributes sort order."},"frontend_label":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backend_type":{"type":"string","description":"Backend type."},"is_used_in_grid":{"type":"boolean","description":"It is used in customer grid"},"is_visible_in_grid":{"type":"boolean","description":"It is visible in customer grid"},"is_filterable_in_grid":{"type":"boolean","description":"It is filterable in customer grid"},"is_searchable_in_grid":{"type":"boolean","description":"It is searchable in customer grid"},"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["frontend_input","input_filter","store_label","validation_rules","multiline_count","visible","required","data_model","options","frontend_class","user_defined","sort_order","frontend_label","note","system","backend_type","attribute_code"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"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":{"is_subscribed":{"type":"boolean"}}},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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":{"bundle_product_options":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}},"downloadable_product_links":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}},"downloadable_product_samples":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"configurable_product_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"configurable_product_links":{"type":"array","items":{"type":"integer"}}}},"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"},"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"},"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"},"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"},"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"},"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"},"catalog-data-product-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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","is_required","frontend_labels"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"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"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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","is_required","frontend_labels"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"Interface AttributeGroupSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-category-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"path":{"type":"string"},"available_sort_by":{"type":"array","items":{"type":"string"}},"include_in_menu":{"type":"boolean"},"extension_attributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"product_count":{"type":"integer","description":"Product count"},"children_data":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parent_id","name","is_active","position","level","product_count","children_data"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"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"]},"framework-search-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"search_criteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","aggregations","search_criteria","total_count"]},"framework-search-document-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucket_names":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucket_names"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"","properties":{"request_name":{"type":"string"},"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["request_name","filter_groups"]},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extension_attributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"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":"integer","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"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-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"},"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"]},"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"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface"},"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"},"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"}}}},"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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrier_code":{"type":"string","description":"Shipping carrier code."},"method_code":{"type":"string","description":"Shipping method code."},"carrier_title":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"method_title":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"base_amount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"error_message":{"type":"string","description":"Shipping Error message."},"price_excl_tax":{"type":"number","description":"Shipping price excl tax."},"price_incl_tax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrier_code","method_code","amount","base_amount","available","error_message","price_excl_tax","price_incl_tax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grand_total":{"type":"number","description":"Grand total in quote currency"},"base_grand_total":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"base_subtotal":{"type":"number","description":"Subtotal in base currency"},"discount_amount":{"type":"number","description":"Discount amount in quote currency"},"base_discount_amount":{"type":"number","description":"Discount amount in base currency"},"subtotal_with_discount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"base_subtotal_with_discount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shipping_amount":{"type":"number","description":"Shipping amount in quote currency"},"base_shipping_amount":{"type":"number","description":"Shipping amount in base currency"},"shipping_discount_amount":{"type":"number","description":"Shipping discount amount in quote currency"},"base_shipping_discount_amount":{"type":"number","description":"Shipping discount amount in base currency"},"tax_amount":{"type":"number","description":"Tax amount in quote currency"},"base_tax_amount":{"type":"number","description":"Tax amount in base currency"},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount in quote currency"},"base_shipping_tax_amount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in quote currency"},"base_subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in base currency"},"shipping_incl_tax":{"type":"number","description":"Shipping including tax in quote currency"},"base_shipping_incl_tax":{"type":"number","description":"Shipping including tax in base currency"},"base_currency_code":{"type":"string","description":"Base currency code"},"quote_currency_code":{"type":"string","description":"Quote currency code"},"coupon_code":{"type":"string","description":"Applied coupon code"},"items_qty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"total_segments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weee_tax_applied_amount","total_segments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"item_id":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"base_price":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"row_total":{"type":"number","description":"Row total in quote currency."},"base_row_total":{"type":"number","description":"Row total in base currency."},"row_total_with_discount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"tax_amount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"base_tax_amount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"tax_percent":{"type":"number","description":"Tax percent. Otherwise, null."},"discount_amount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"base_discount_amount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discount_percent":{"type":"number","description":"Discount percent. Otherwise, null."},"price_incl_tax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"base_price_incl_tax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"row_total_incl_tax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"base_row_total_incl_tax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weee_tax_applied":{"type":"string","description":"Item weee tax applied in quote currency."},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["item_id","price","base_price","qty","row_total","base_row_total","options","weee_tax_applied_amount","weee_tax_applied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extension_attributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"tax_grandtotal_details":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}}}},"tax-data-grand-total-details-interface":{"type":"object","description":"Interface GrandTotalDetailsInterface","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"group_id":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","group_id"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"Interface GrandTotalRatesInterface","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface"},"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"}}},"checkout-agreements-data-agreement-interface":{"type":"object","description":"Interface AgreementInterface","properties":{"agreement_id":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"content_height":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkbox_text":{"type":"string","description":"Agreement checkbox text."},"is_active":{"type":"boolean","description":"Agreement status."},"is_html":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extension_attributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreement_id","name","content","checkbox_text","is_active","is_html","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"catalog-inventory-data-stock-status-collection-interface":{"type":"object","description":"Stock Status collection interface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"search_criteria":{"$ref":"#/definitions/catalog-inventory-stock-status-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"product_id":{"type":"integer"},"stock_id":{"type":"integer"},"qty":{"type":"integer"},"stock_status":{"type":"integer"},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["product_id","stock_id","qty","stock_status","stock_item"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"catalog-inventory-stock-status-criteria-interface":{"type":"object","description":"Interface StockStatusCriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"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"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-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"}}},"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"}},"gift_message":{"$ref":"#/definitions/gift-message-data-message-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"}}},"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"},"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"},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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"},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-creditmemo-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-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"},"sales-data-creditmemo-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoInterface"},"sales-data-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transaction_id":{"type":"integer","description":"Transaction ID."},"parent_id":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"order_id":{"type":"integer","description":"Order ID."},"payment_id":{"type":"integer","description":"Payment ID."},"txn_id":{"type":"string","description":"Transaction business ID."},"parent_txn_id":{"type":"string","description":"Parent transaction business ID."},"txn_type":{"type":"string","description":"Transaction type."},"is_closed":{"type":"integer","description":"Is-closed flag value."},"additional_information":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"created_at":{"type":"string","description":"Created-at timestamp."},"child_transactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transaction_id","order_id","payment_id","txn_id","parent_txn_id","txn_type","is_closed","created_at","child_transactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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-payment-details-interface":{"type":"object","description":"Interface PaymentDetailsInterface","properties":{"payment_methods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extension_attributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["payment_methods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"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"},"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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failed_items":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missing_items":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failed_items","missing_items"]}}} \ No newline at end of file diff --git a/src/swagger/schemas/2.2.0.schema.json b/src/swagger/schemas/2.2.0.schema.json deleted file mode 100644 index a2cfe23870b..00000000000 --- a/src/swagger/schemas/2.2.0.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.2","title":"Magento Commerce for B2B 2.2"},"host":"b2b2.vg","basePath":"/index.php/rest/default","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerGroupConfigV1","description":"Interface for system configuration operations for customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogTierPriceStorageV1","description":"Tier prices storage."},{"name":"catalogBasePriceStorageV1","description":"Base prices storage."},{"name":"catalogCostStorageV1","description":"Product cost storage."},{"name":"catalogSpecialPriceStorageV1","description":"Special price storage presents efficient price API and is used to retrieve, update or delete special prices."},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogCategoryListV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":"Interface ProductWebsiteLinkRepositoryInterface"},{"name":"catalogProductRenderListV1","description":"Interface which provides product renders information for products"},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteGuestShipmentEstimationV1","description":"Interface GuestShipmentEstimationInterface"},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"requisitionListRequisitionListRepositoryV1","description":"Interface RequisitionListRepositoryInterface"},{"name":"searchV1","description":"Search API for all requests"},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesRefundInvoiceV1","description":"Interface RefundInvoiceInterface"},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesRefundOrderV1","description":"Interface RefundOrderInterface"},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesShipOrderV1","description":"Class ShipOrderInterface"},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"salesInvoiceOrderV1","description":"Class InvoiceOrderInterface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"companyCompanyRepositoryV1","description":"A repository interface for company entity that provides basic CRUD operations."},{"name":"companyTeamRepositoryV1","description":"Interface for basic CRUD operations for team entity."},{"name":"companyCompanyHierarchyV1","description":"Interface for working with company hierarchy."},{"name":"companyRoleRepositoryV1","description":"A repository interface for role entity that provides basic CRUD operations."},{"name":"companyAclV1","description":"Access control list interface."},{"name":"customerBalanceBalanceManagementV1","description":"Customer balance(store credit) operations"},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"},{"name":"sharedCatalogSharedCatalogRepositoryV1","description":""},{"name":"sharedCatalogCompanyManagementV1","description":"Shared catalog companies actions."},{"name":"sharedCatalogProductManagementV1","description":"Shared catalog products actions."},{"name":"sharedCatalogCategoryManagementV1","description":"Shared catalog products actions."},{"name":"giftCardAccountGiftCardAccountManagementV1","description":"Interface GiftCardAccountManagementInterface"},{"name":"giftCardAccountGuestGiftCardAccountManagementV1","description":"Interface GuestGiftCardAccountManagementInterface"},{"name":"negotiableQuoteNegotiableQuoteManagementV1","description":"Interface for managing quotes."},{"name":"negotiableQuoteNegotiableQuotePriceManagementV1","description":"Interface for updating quote prices in case price changes occur in system."},{"name":"negotiableQuoteAttachmentContentManagementV1","description":"Interface for retrieving the list of negotiable quotes attachments."},{"name":"negotiableQuoteCommentLocatorV1","description":"Interface for load quote comments with attachment."},{"name":"negotiableQuoteNegotiableQuoteShippingManagementV1","description":"Interface for add and update negotiable quote shipping method."},{"name":"negotiableQuotePaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"negotiableQuoteShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"negotiableQuoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"negotiableQuoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"negotiableQuoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"negotiableQuoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"negotiableQuoteCouponManagementV1","description":"Coupon management service interface."},{"name":"negotiableQuoteGiftCardAccountManagementV1","description":"Interface GiftCardAccountManagementInterface"},{"name":"giftRegistryShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"giftRegistryGuestCartShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"},{"name":"giftWrappingWrappingRepositoryV1","description":"Interface WrappingRepositoryInterface"},{"name":"companyCreditCreditLimitRepositoryV1","description":"Interface for credit limit repository for CRUD operations."},{"name":"companyCreditCreditLimitManagementV1","description":"Credit Limit management interface."},{"name":"companyCreditCreditBalanceManagementV1","description":"Interface for management decrease and increase credit balance operations."},{"name":"companyCreditCreditHistoryManagementV1","description":"Update credit history log and retrieve history which match a specified criteria."},{"name":"rewardRewardManagementV1","description":"Interface RewardManagementInterface"},{"name":"rmaTrackManagementV1","description":"Interface TrackManagementInterface"},{"name":"rmaRmaRepositoryV1","description":"Interface RmaRepositoryInterface"},{"name":"rmaCommentManagementV1","description":"Interface CommentRepositoryInterface"},{"name":"rmaRmaManagementV1","description":"Interface RmaManagementInterface"},{"name":"rmaRmaAttributesManagementV1","description":"Interface RmaAttributesManagementInterface"},{"name":"worldpayGuestPaymentInformationManagementProxyV1","description":"Interface GuestPaymentInformationManagementProxyInterface"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{id}":{"put":{"tags":["customerCustomerGroupConfigV1"],"description":"Set system default customer group.","operationId":"customerCustomerGroupConfigV1SetDefaultCustomerGroupPut","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{id}":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","parameters":[{"name":"$body","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices-information":{"post":{"tags":["catalogTierPriceStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogTierPriceStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices":{"post":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices-delete":{"post":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/base-prices-information":{"post":{"tags":["catalogBasePriceStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogBasePriceStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-base-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/base-prices":{"post":{"tags":["catalogBasePriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-base-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost-information":{"post":{"tags":["catalogCostStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogCostStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-cost-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost":{"post":{"tags":["catalogCostStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-cost-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost-delete":{"post":{"tags":["catalogCostStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will return True if deleted."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price-information":{"post":{"tags":["catalogSpecialPriceStorageV1"],"description":"Return product's special price. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogSpecialPriceStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price":{"post":{"tags":["catalogSpecialPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price-delete":{"post":{"tags":["catalogSpecialPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/list":{"get":{"tags":["catalogCategoryListV1"],"description":"Get category list","operationId":"catalogCategoryListV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products-render-info":{"get":{"tags":["catalogProductRenderListV1"],"description":"Collect and retrieve the list of product render info This info contains raw prices and formated prices, product name, stock status, store_id, etc","operationId":"catalogProductRenderListV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."},{"name":"storeId","in":"query","type":"integer","required":true},{"name":"currencyCode","in":"query","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-render-search-results-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"put":{"tags":["quoteCartRepositoryV1"],"description":"Save quote","operationId":"quoteCartRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer if customer does not have a cart yet.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"new cart ID if customer did not have a cart or ID of the existing cart otherwise."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}":{"put":{"tags":["quoteCartRepositoryV1"],"description":"Save quote","operationId":"quoteCartRepositoryV1SavePut","parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer if customer does not have a cart yet.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"new cart ID if customer did not have a cart or ID of the existing cart otherwise."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/items":{"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/requisition_lists":{"post":{"tags":["requisitionListRequisitionListRepositoryV1"],"description":"Save Requisition List","operationId":"requisitionListRequisitionListRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["requisitionList"],"properties":{"requisitionList":{"$ref":"#/definitions/requisition-list-data-requisition-list-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/requisition-list-data-requisition-list-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/create":{"put":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/":{"post":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"$body","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoice/{invoiceId}/refund":{"post":{"tags":["salesRefundInvoiceV1"],"description":"Create refund for invoice","operationId":"salesRefundInvoiceV1ExecutePost","parameters":[{"name":"invoiceId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/refund":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Prepare creditmemo to refund and save it.","operationId":"salesCreditmemoManagementV1RefundPost","parameters":[{"name":"$body","in":"body","schema":{"required":["creditmemo"],"properties":{"creditmemo":{"$ref":"#/definitions/sales-data-creditmemo-interface"},"offlineRequested":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/refund":{"post":{"tags":["salesRefundOrderV1"],"description":"Create offline refund for order","operationId":"salesRefundOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/ship":{"post":{"tags":["salesShipOrderV1"],"description":"Creates new Shipment for given Order.","operationId":"salesShipOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Id of created Shipment."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/invoice":{"post":{"tags":["salesInvoiceOrderV1"],"description":"","operationId":"salesInvoiceOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"$body","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"$body","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"$body","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Configurable product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/":{"get":{"tags":["companyCompanyRepositoryV1"],"description":"Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included.","operationId":"companyCompanyRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["companyCompanyRepositoryV1"],"description":"Create or update a company account.","operationId":"companyCompanyRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["company"],"properties":{"company":{"$ref":"#/definitions/company-data-company-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/{companyId}":{"get":{"tags":["companyCompanyRepositoryV1"],"description":"Returns company details.","operationId":"companyCompanyRepositoryV1GetGet","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyCompanyRepositoryV1"],"description":"Delete a company. Customers belonging to a company are not deleted with this request.","operationId":"companyCompanyRepositoryV1DeleteByIdDelete","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["companyCompanyRepositoryV1"],"description":"Create or update a company account.","operationId":"companyCompanyRepositoryV1SavePut","parameters":[{"name":"companyId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["company"],"properties":{"company":{"$ref":"#/definitions/company-data-company-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/":{"get":{"tags":["companyTeamRepositoryV1"],"description":"Returns the list of teams for the specified search criteria (team name or description).","operationId":"companyTeamRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-team-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/{teamId}":{"get":{"tags":["companyTeamRepositoryV1"],"description":"Returns data for a team in the company, by entity id.","operationId":"companyTeamRepositoryV1GetGet","parameters":[{"name":"teamId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-team-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyTeamRepositoryV1"],"description":"Delete a team from the company structure.","operationId":"companyTeamRepositoryV1DeleteByIdDelete","parameters":[{"name":"teamId","in":"path","type":"integer","required":true}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["companyTeamRepositoryV1"],"description":"Update a team in the company structure.","operationId":"companyTeamRepositoryV1SavePut","parameters":[{"name":"teamId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["team"],"properties":{"team":{"$ref":"#/definitions/company-data-team-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/{companyId}":{"post":{"tags":["companyTeamRepositoryV1"],"description":"Create a team in the company structure.","operationId":"companyTeamRepositoryV1CreatePost","parameters":[{"name":"companyId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["team"],"properties":{"team":{"$ref":"#/definitions/company-data-team-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/hierarchy/{id}":{"get":{"tags":["companyCompanyHierarchyV1"],"description":"Returns the list of teams and company users in the company structure.","operationId":"companyCompanyHierarchyV1GetCompanyHierarchyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/company-data-hierarchy-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/hierarchy/move/{id}":{"put":{"tags":["companyCompanyHierarchyV1"],"description":"Moves teams and users within the company structure.","operationId":"companyCompanyHierarchyV1MoveNodePut","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["newParentId"],"properties":{"newParentId":{"type":"integer"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/":{"get":{"tags":["companyRoleRepositoryV1"],"description":"Returns the list of roles and permissions for a specified company.","operationId":"companyRoleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["companyRoleRepositoryV1"],"description":"Create or update a role for a selected company.","operationId":"companyRoleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["role"],"properties":{"role":{"$ref":"#/definitions/company-data-role-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{roleId}":{"get":{"tags":["companyRoleRepositoryV1"],"description":"Returns the list of permissions for a specified role.","operationId":"companyRoleRepositoryV1GetGet","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyRoleRepositoryV1"],"description":"Delete a role.","operationId":"companyRoleRepositoryV1DeleteDelete","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{id}":{"put":{"tags":["companyRoleRepositoryV1"],"description":"Create or update a role for a selected company.","operationId":"companyRoleRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["role"],"properties":{"role":{"$ref":"#/definitions/company-data-role-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/assignRoles":{"put":{"tags":["companyAclV1"],"description":"Change a role for a company user.","operationId":"companyAclV1AssignRolesPut","parameters":[{"name":"$body","in":"body","schema":{"required":["userId","roles"],"properties":{"userId":{"type":"integer"},"roles":{"type":"array","items":{"$ref":"#/definitions/company-data-role-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{roleId}/users":{"get":{"tags":["companyAclV1"],"description":"View the list of company users assigned to a specified role.","operationId":"companyAclV1GetUsersByRoleIdGet","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-customer-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/balance/apply":{"post":{"tags":["customerBalanceBalanceManagementV1"],"description":"Apply store credit","operationId":"customerBalanceBalanceManagementV1ApplyPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}":{"get":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Return the following properties for the selected shared catalog: ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.","operationId":"sharedCatalogSharedCatalogRepositoryV1GetGet","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Delete a shared catalog by ID.","operationId":"sharedCatalogSharedCatalogRepositoryV1DeleteByIdDelete","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog":{"post":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Create or update Shared Catalog service.","operationId":"sharedCatalogSharedCatalogRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["sharedCatalog"],"properties":{"sharedCatalog":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}":{"put":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Create or update Shared Catalog service.","operationId":"sharedCatalogSharedCatalogRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sharedCatalog"],"properties":{"sharedCatalog":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/":{"get":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Return the list of shared catalogs and basic properties for each catalog.","operationId":"sharedCatalogSharedCatalogRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/shared-catalog-data-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/companies":{"get":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Return the list of company IDs for the companies assigned to the selected catalog.","operationId":"sharedCatalogCompanyManagementV1GetCompaniesGet","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/assignCompanies":{"post":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Assign companies to a shared catalog.","operationId":"sharedCatalogCompanyManagementV1AssignCompaniesPost","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["companies"],"properties":{"companies":{"type":"array","items":{"$ref":"#/definitions/company-data-company-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/unassignCompanies":{"post":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Unassign companies from a shared catalog.","operationId":"sharedCatalogCompanyManagementV1UnassignCompaniesPost","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["companies"],"properties":{"companies":{"type":"array","items":{"$ref":"#/definitions/company-data-company-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/products":{"get":{"tags":["sharedCatalogProductManagementV1"],"description":"Return the list of product SKUs in the selected shared catalog.","operationId":"sharedCatalogProductManagementV1GetProductsGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/assignProducts":{"post":{"tags":["sharedCatalogProductManagementV1"],"description":"Add products into the shared catalog.","operationId":"sharedCatalogProductManagementV1AssignProductsPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/unassignProducts":{"post":{"tags":["sharedCatalogProductManagementV1"],"description":"Remove the specified products from the shared catalog.","operationId":"sharedCatalogProductManagementV1UnassignProductsPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/categories":{"get":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Return the list of categories in the selected shared catalog.","operationId":"sharedCatalogCategoryManagementV1GetCategoriesGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"integer"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/assignCategories":{"post":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Add categories into the shared catalog.","operationId":"sharedCatalogCategoryManagementV1AssignCategoriesPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["categories"],"properties":{"categories":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/unassignCategories":{"post":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Remove the specified categories from the shared catalog.","operationId":"sharedCatalogCategoryManagementV1UnassignCategoriesPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["categories"],"properties":{"categories":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/giftCards":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Return GiftCard Account cards","operationId":"giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards":{"put":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards":{"post":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards":{"post":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/request":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/submitToCustomer":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/decline":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["quoteId","reason"],"properties":{"quoteId":{"type":"integer"},"reason":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/pricesUpdated":{"post":{"tags":["negotiableQuoteNegotiableQuotePriceManagementV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["quoteIds"],"properties":{"quoteIds":{"type":"array","items":{"type":"integer"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/attachmentContent":{"get":{"tags":["negotiableQuoteAttachmentContentManagementV1"],"description":"Returns content for one or more files attached on the quote comment.","operationId":"negotiableQuoteAttachmentContentManagementV1GetGet","parameters":[{"name":"attachmentIds","in":"query","type":"array","items":{"type":"integer"},"required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/negotiable-quote-data-attachment-content-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}/comments":{"get":{"tags":["negotiableQuoteCommentLocatorV1"],"description":"Returns comments for a specified negotiable quote.","operationId":"negotiableQuoteCommentLocatorV1GetListForQuoteGet","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true,"description":"Negotiable Quote ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of quote comments.","items":{"$ref":"#/definitions/negotiable-quote-data-comment-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}/shippingMethod":{"put":{"tags":["negotiableQuoteNegotiableQuoteShippingManagementV1"],"description":"Updates the shipping method on a negotiable quote.","operationId":"negotiableQuoteNegotiableQuoteShippingManagementV1SetShippingMethodPut","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true,"description":"Negotiable Quote id"},{"name":"$body","in":"body","schema":{"required":["shippingMethod"],"properties":{"shippingMethod":{"type":"string","description":"The shipping method code."}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/payment-information":{"post":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Get payment information","operationId":"negotiableQuotePaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/set-payment-information":{"post":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/shipping-information":{"post":{"tags":["negotiableQuoteShippingInformationManagementV1"],"description":"","operationId":"negotiableQuoteShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["negotiableQuoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["negotiableQuoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/billing-address":{"get":{"tags":["negotiableQuoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"negotiableQuoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["negotiableQuoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"negotiableQuoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/totals":{"get":{"tags":["negotiableQuoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"negotiableQuoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["negotiableQuoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"negotiableQuoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/coupons":{"delete":{"tags":["negotiableQuoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"negotiableQuoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/giftCards":{"post":{"tags":["negotiableQuoteGiftCardAccountManagementV1"],"description":"","operationId":"negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["negotiableQuoteGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"negotiableQuoteGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/giftregistry/mine/estimate-shipping-methods":{"post":{"tags":["giftRegistryShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":{"post":{"tags":["giftRegistryGuestCartShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{id}":{"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return data object for specified wrapping ID and store.","operationId":"giftWrappingWrappingRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Delete gift wrapping","operationId":"giftWrappingWrappingRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings":{"post":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return list of gift wrapping data objects based on search criteria","operationId":"giftWrappingWrappingRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{wrappingId}":{"put":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePut","parameters":[{"name":"wrappingId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/":{"get":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Returns the list of credits for specified companies.","operationId":"companyCreditCreditLimitRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}":{"get":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Returns data on the credit limit for a specified credit limit ID.","operationId":"companyCreditCreditLimitRepositoryV1GetGet","parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"reload","in":"query","type":"boolean","description":"[optional]","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{id}":{"put":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Update the following company credit attributes: credit currency, credit limit and setting to exceed credit.","operationId":"companyCreditCreditLimitRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["creditLimit"],"properties":{"creditLimit":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/company/{companyId}":{"get":{"tags":["companyCreditCreditLimitManagementV1"],"description":"Returns data on the credit limit for a specified company.","operationId":"companyCreditCreditLimitManagementV1GetCreditByCompanyIdGet","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}/increaseBalance":{"post":{"tags":["companyCreditCreditBalanceManagementV1"],"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","parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}/decreaseBalance":{"post":{"tags":["companyCreditCreditBalanceManagementV1"],"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","parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/history":{"get":{"tags":["companyCreditCreditHistoryManagementV1"],"description":"Returns the credit history for one or more companies.","operationId":"companyCreditCreditHistoryManagementV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-history-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/history/{historyId}":{"put":{"tags":["companyCreditCreditHistoryManagementV1"],"description":"Update the PO Number and/or comment for a Reimburse transaction.","operationId":"companyCreditCreditHistoryManagementV1UpdatePut","parameters":[{"name":"historyId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"properties":{"purchaseOrder":{"type":"string","description":"[optional]"},"comment":{"type":"string","description":"[optional]"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/reward/mine/use-reward":{"post":{"tags":["rewardRewardManagementV1"],"description":"Set reward points to quote","operationId":"rewardRewardManagementV1SetPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers":{"post":{"tags":["rmaTrackManagementV1"],"description":"Add track","operationId":"rmaTrackManagementV1AddTrackPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["track"],"properties":{"track":{"$ref":"#/definitions/rma-data-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaTrackManagementV1"],"description":"Get track list","operationId":"rmaTrackManagementV1GetTracksGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-track-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers/{trackId}":{"delete":{"tags":["rmaTrackManagementV1"],"description":"Remove track by id","operationId":"rmaTrackManagementV1RemoveTrackByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"trackId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/labels":{"get":{"tags":["rmaTrackManagementV1"],"description":"Get shipping label int the PDF format","operationId":"rmaTrackManagementV1GetShippingLabelPdfGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}":{"get":{"tags":["rmaRmaRepositoryV1"],"description":"Return data object for specified RMA id","operationId":"rmaRmaRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["rmaRmaRepositoryV1"],"description":"Delete RMA","operationId":"rmaRmaRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/comments":{"post":{"tags":["rmaCommentManagementV1"],"description":"Add comment","operationId":"rmaCommentManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/rma-data-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaCommentManagementV1"],"description":"Comments list","operationId":"rmaCommentManagementV1CommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns":{"post":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPost","parameters":[{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaRmaManagementV1"],"description":"Return list of rma data objects based on search criteria","operationId":"rmaRmaManagementV1SearchGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/{attributeCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/form/{formCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve all attributes filtered by form code","operationId":"rmaRmaAttributesManagementV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get all attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/custom":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get custom attribute metadata for the given Data object's attribute set","operationId":"rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataObjectClassName","in":"query","type":"string","description":"Data object class name","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/framework-metadata-object-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/worldpay-guest-carts/{cartId}/payment-information":{"post":{"tags":["worldpayGuestPaymentInformationManagementProxyV1"],"description":"Proxy handler for guest place order","operationId":"worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"website_id":{"type":"integer"},"store_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","website_id","store_group_id"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"website_id":{"type":"integer"},"root_category_id":{"type":"integer"},"default_store_id":{"type":"integer"},"name":{"type":"string"},"code":{"type":"string","description":"Group code."},"extension_attributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","website_id","root_category_id","default_store_id","name","code"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"default_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","default_group_id"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"website_id":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"base_currency_code":{"type":"string","description":"Base currency code"},"default_display_currency_code":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weight_unit":{"type":"string","description":"The unit of weight"},"base_url":{"type":"string","description":"Base URL for the store"},"base_link_url":{"type":"string","description":"Base link URL for the store"},"base_static_url":{"type":"string","description":"Base static URL for the store"},"base_media_url":{"type":"string","description":"Base media URL for the store"},"secure_base_url":{"type":"string","description":"Secure base URL for the store"},"secure_base_link_url":{"type":"string","description":"Secure base link URL for the store"},"secure_base_static_url":{"type":"string","description":"Secure base static URL for the store"},"secure_base_media_url":{"type":"string","description":"Secure base media URL for the store"},"extension_attributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","website_id","locale","base_currency_code","default_display_currency_code","timezone","weight_unit","base_url","base_link_url","base_static_url","base_media_url","secure_base_url","secure_base_link_url","secure_base_static_url","secure_base_media_url"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"base_currency_code":{"type":"string","description":"The base currency code for the store."},"base_currency_symbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"default_display_currency_code":{"type":"string","description":"The default display currency code for the store."},"default_display_currency_symbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"available_currency_codes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchange_rates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["base_currency_code","base_currency_symbol","default_display_currency_code","default_display_currency_symbol","available_currency_codes","exchange_rates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currency_to":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extension_attributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currency_to","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"two_letter_abbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"three_letter_abbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"full_name_locale":{"type":"string","description":"The country full name (in store locale) for the store."},"full_name_english":{"type":"string","description":"The country full name (in English) for the store."},"available_regions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","two_letter_abbreviation","three_letter_abbreviation","full_name_locale","full_name_english"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extension_attributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"Interface AttributeSetSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["filter_groups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"condition_type":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"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-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontend_input":{"type":"string","description":"HTML for input element."},"input_filter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"store_label":{"type":"string","description":"Label of the store."},"validation_rules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multiline_count":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"data_model":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontend_class":{"type":"string","description":"Class which is used to display the attribute on frontend."},"user_defined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sort_order":{"type":"integer","description":"Attributes sort order."},"frontend_label":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backend_type":{"type":"string","description":"Backend type."},"is_used_in_grid":{"type":"boolean","description":"It is used in customer grid"},"is_visible_in_grid":{"type":"boolean","description":"It is visible in customer grid"},"is_filterable_in_grid":{"type":"boolean","description":"It is filterable in customer grid"},"is_searchable_in_grid":{"type":"boolean","description":"It is searchable in customer grid"},"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["frontend_input","input_filter","store_label","validation_rules","multiline_count","visible","required","data_model","options","frontend_class","user_defined","sort_order","frontend_label","note","system","backend_type","attribute_code"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"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"}}},"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"},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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"},"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-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"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"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"Interface AttributeGroupSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-price-update-result-interface":{"type":"object","description":"Interface returned in case of incorrect price passed to efficient price API.","properties":{"message":{"type":"string","description":"Error message, that contains description of error occurred during price update."},"parameters":{"type":"array","description":"Parameters, that could be displayed in error message placeholders.","items":{"type":"string"}},"extension_attributes":{"$ref":"#/definitions/catalog-data-price-update-result-extension-interface"}},"required":["message","parameters"]},"catalog-data-price-update-result-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface"},"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":"","properties":{"id":{"type":"integer"},"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"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"path":{"type":"string"},"available_sort_by":{"type":"array","items":{"type":"string"}},"include_in_menu":{"type":"boolean"},"extension_attributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"product_count":{"type":"integer","description":"Product count"},"children_data":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parent_id","name","is_active","position","level","product_count","children_data"]},"catalog-data-category-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Categories","items":{"$ref":"#/definitions/catalog-data-category-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"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"]},"catalog-data-product-render-search-results-interface":{"type":"object","description":"Dto that holds render information about products","properties":{"items":{"type":"array","description":"List of products rendered information","items":{"$ref":"#/definitions/catalog-data-product-render-interface"}}},"required":["items"]},"catalog-data-product-render-interface":{"type":"object","description":"Represents Data Object which holds enough information to render product This information is put into part as Add To Cart or Add to Compare Data or Price Data","properties":{"add_to_cart_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"add_to_compare_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"price_info":{"$ref":"#/definitions/catalog-data-product-render-price-info-interface"},"images":{"type":"array","description":"Enough information, that needed to render image on front","items":{"$ref":"#/definitions/catalog-data-product-render-image-interface"}},"url":{"type":"string","description":"Product url"},"id":{"type":"integer","description":"Product identifier"},"name":{"type":"string","description":"Product name"},"type":{"type":"string","description":"Product type. Such as bundle, grouped, simple, etc..."},"is_salable":{"type":"string","description":"Information about product saleability (In Stock)"},"store_id":{"type":"integer","description":"Information about current store id or requested store id"},"currency_code":{"type":"string","description":"Current or desired currency code to product"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-extension-interface"}},"required":["add_to_cart_button","add_to_compare_button","price_info","images","url","id","name","type","is_salable","store_id","currency_code","extension_attributes"]},"catalog-data-product-render-button-interface":{"type":"object","description":"Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend","properties":{"post_data":{"type":"string","description":"Post data"},"url":{"type":"string","description":"Url, needed to add product to cart"},"required_options":{"type":"boolean","description":"Flag whether a product has options or not"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-button-extension-interface"}},"required":["post_data","url","required_options"]},"catalog-data-product-render-button-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ButtonInterface"},"catalog-data-product-render-price-info-interface":{"type":"object","description":"Price interface.","properties":{"final_price":{"type":"number","description":"Final price"},"max_price":{"type":"number","description":"Max price of a product"},"max_regular_price":{"type":"number","description":"Max regular price"},"minimal_regular_price":{"type":"number","description":"Minimal regular price"},"special_price":{"type":"number","description":"Special price"},"minimal_price":{"type":"number"},"regular_price":{"type":"number","description":"Regular price"},"formatted_prices":{"$ref":"#/definitions/catalog-data-product-render-formatted-price-info-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-price-info-extension-interface"}},"required":["final_price","max_price","max_regular_price","minimal_regular_price","special_price","minimal_price","regular_price","formatted_prices"]},"catalog-data-product-render-formatted-price-info-interface":{"type":"object","description":"Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html","properties":{"final_price":{"type":"string","description":"Html with final price"},"max_price":{"type":"string","description":"Max price of a product"},"minimal_price":{"type":"string","description":"The minimal price of the product or variation"},"max_regular_price":{"type":"string","description":"Max regular price"},"minimal_regular_price":{"type":"string","description":"Minimal regular price"},"special_price":{"type":"string","description":"Special price"},"regular_price":{"type":"string","description":"Price - is price of product without discounts and special price with taxes and fixed product tax"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-formatted-price-info-extension-interface"}},"required":["final_price","max_price","minimal_price","max_regular_price","minimal_regular_price","special_price","regular_price"]},"catalog-data-product-render-formatted-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\FormattedPriceInfoInterface"},"catalog-data-product-render-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\PriceInfoInterface","properties":{"msrp":{"$ref":"#/definitions/msrp-data-product-render-msrp-price-info-interface"},"tax_adjustments":{"$ref":"#/definitions/catalog-data-product-render-price-info-interface"},"weee_attributes":{"type":"array","items":{"$ref":"#/definitions/weee-data-product-render-weee-adjustment-attribute-interface"}},"weee_adjustment":{"type":"string"}}},"msrp-data-product-render-msrp-price-info-interface":{"type":"object","description":"Price interface.","properties":{"msrp_price":{"type":"string"},"is_applicable":{"type":"string"},"is_shown_price_on_gesture":{"type":"string"},"msrp_message":{"type":"string"},"explanation_message":{"type":"string"},"extension_attributes":{"$ref":"#/definitions/msrp-data-product-render-msrp-price-info-extension-interface"}},"required":["msrp_price","is_applicable","is_shown_price_on_gesture","msrp_message","explanation_message"]},"msrp-data-product-render-msrp-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Msrp\\Api\\Data\\ProductRender\\MsrpPriceInfoInterface"},"weee-data-product-render-weee-adjustment-attribute-interface":{"type":"object","description":"List of all weee attributes, their amounts, etc.., that product has","properties":{"amount":{"type":"string","description":"Weee attribute amount"},"tax_amount":{"type":"string","description":"Tax which is calculated to fixed product tax attribute"},"tax_amount_incl_tax":{"type":"string","description":"Tax amount of weee attribute"},"amount_excl_tax":{"type":"string","description":"Product amount exclude tax"},"attribute_code":{"type":"string","description":"Weee attribute code"},"extension_attributes":{"$ref":"#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface"}},"required":["amount","tax_amount","tax_amount_incl_tax","amount_excl_tax","attribute_code","extension_attributes"]},"weee-data-product-render-weee-adjustment-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Weee\\Api\\Data\\ProductRender\\WeeeAdjustmentAttributeInterface"},"catalog-data-product-render-image-interface":{"type":"object","description":"Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view","properties":{"url":{"type":"string","description":"Image url"},"code":{"type":"string","description":"Image code"},"height":{"type":"number","description":"Image height"},"width":{"type":"number","description":"Image width in px"},"label":{"type":"string","description":"Image label"},"resized_width":{"type":"number","description":"Resize width"},"resized_height":{"type":"number","description":"Resize height"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-image-extension-interface"}},"required":["url","code","height","width","label","resized_width","resized_height"]},"catalog-data-product-render-image-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ImageInterface"},"catalog-data-product-render-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRenderInterface","properties":{"wishlist_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"review_html":{"type":"string"}}},"catalog-inventory-data-stock-status-collection-interface":{"type":"object","description":"Stock Status collection interface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"search_criteria":{"$ref":"#/definitions/catalog-inventory-stock-status-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"product_id":{"type":"integer"},"stock_id":{"type":"integer"},"qty":{"type":"integer"},"stock_status":{"type":"integer"},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["product_id","stock_id","qty","stock_status","stock_item"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"catalog-inventory-stock-status-criteria-interface":{"type":"object","description":"Interface StockStatusCriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extension_attributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"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":"integer","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"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface","properties":{"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-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":{"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"}}},"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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrier_code":{"type":"string","description":"Shipping carrier code."},"method_code":{"type":"string","description":"Shipping method code."},"carrier_title":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"method_title":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"base_amount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"error_message":{"type":"string","description":"Shipping Error message."},"price_excl_tax":{"type":"number","description":"Shipping price excl tax."},"price_incl_tax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrier_code","method_code","amount","base_amount","available","error_message","price_excl_tax","price_incl_tax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grand_total":{"type":"number","description":"Grand total in quote currency"},"base_grand_total":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"base_subtotal":{"type":"number","description":"Subtotal in base currency"},"discount_amount":{"type":"number","description":"Discount amount in quote currency"},"base_discount_amount":{"type":"number","description":"Discount amount in base currency"},"subtotal_with_discount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"base_subtotal_with_discount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shipping_amount":{"type":"number","description":"Shipping amount in quote currency"},"base_shipping_amount":{"type":"number","description":"Shipping amount in base currency"},"shipping_discount_amount":{"type":"number","description":"Shipping discount amount in quote currency"},"base_shipping_discount_amount":{"type":"number","description":"Shipping discount amount in base currency"},"tax_amount":{"type":"number","description":"Tax amount in quote currency"},"base_tax_amount":{"type":"number","description":"Tax amount in base currency"},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount in quote currency"},"base_shipping_tax_amount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in quote currency"},"base_subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in base currency"},"shipping_incl_tax":{"type":"number","description":"Shipping including tax in quote currency"},"base_shipping_incl_tax":{"type":"number","description":"Shipping including tax in base currency"},"base_currency_code":{"type":"string","description":"Base currency code"},"quote_currency_code":{"type":"string","description":"Quote currency code"},"coupon_code":{"type":"string","description":"Applied coupon code"},"items_qty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"total_segments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weee_tax_applied_amount","total_segments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"item_id":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"base_price":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"row_total":{"type":"number","description":"Row total in quote currency."},"base_row_total":{"type":"number","description":"Row total in base currency."},"row_total_with_discount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"tax_amount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"base_tax_amount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"tax_percent":{"type":"number","description":"Tax percent. Otherwise, null."},"discount_amount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"base_discount_amount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discount_percent":{"type":"number","description":"Discount percent. Otherwise, null."},"price_incl_tax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"base_price_incl_tax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"row_total_incl_tax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"base_row_total_incl_tax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weee_tax_applied":{"type":"string","description":"Item weee tax applied in quote currency."},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["item_id","price","base_price","qty","row_total","base_row_total","options","weee_tax_applied_amount","weee_tax_applied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface","properties":{"negotiable_quote_item_totals":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface"}}},"negotiable-quote-data-negotiable-quote-item-totals-interface":{"type":"object","description":"Extension attribute for quote item totals model.","properties":{"cost":{"type":"number","description":"Cost for quote item."},"catalog_price":{"type":"number","description":"Catalog price for quote item."},"base_catalog_price":{"type":"number","description":"Catalog price for quote item in base currency."},"catalog_price_incl_tax":{"type":"number","description":"Catalog price with included tax for quote item."},"base_catalog_price_incl_tax":{"type":"number","description":"Catalog price with included tax for quote item in base currency."},"cart_price":{"type":"number","description":"Cart price for quote item."},"base_cart_price":{"type":"number","description":"Cart price for quote item in base currency."},"cart_tax":{"type":"number","description":"Tax from catalog price for quote item."},"base_cart_tax":{"type":"number","description":"Tax from catalog price for quote item in base currency."},"cart_price_incl_tax":{"type":"number","description":"Cart price with included tax for quote item."},"base_cart_price_incl_tax":{"type":"number","description":"Cart price with included tax for quote item in base currency."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface"}},"required":["cost","catalog_price","base_catalog_price","catalog_price_incl_tax","base_catalog_price_incl_tax","cart_price","base_cart_price","cart_tax","base_cart_tax","cart_price_incl_tax","base_cart_price_incl_tax"]},"negotiable-quote-data-negotiable-quote-item-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteItemTotalsInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extension_attributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"tax_grandtotal_details":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}},"gift_cards":{"type":"string"},"gw_order_id":{"type":"string"},"gw_item_ids":{"type":"array","items":{"type":"string"}},"gw_allow_gift_receipt":{"type":"string"},"gw_add_card":{"type":"string"},"gw_price":{"type":"string"},"gw_base_price":{"type":"string"},"gw_items_price":{"type":"string"},"gw_items_base_price":{"type":"string"},"gw_card_price":{"type":"string"},"gw_card_base_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_price_incl_tax":{"type":"string"},"gw_base_price_incl_tax":{"type":"string"},"gw_card_price_incl_tax":{"type":"string"},"gw_card_base_price_incl_tax":{"type":"string"},"gw_items_price_incl_tax":{"type":"string"},"gw_items_base_price_incl_tax":{"type":"string"}}},"tax-data-grand-total-details-interface":{"type":"object","description":"Interface GrandTotalDetailsInterface","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"group_id":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","group_id"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"Interface GrandTotalRatesInterface","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface","properties":{"coupon_label":{"type":"string"},"base_customer_balance_amount":{"type":"number"},"customer_balance_amount":{"type":"number"},"negotiable_quote_totals":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-totals-interface"},"reward_points_balance":{"type":"number"},"reward_currency_amount":{"type":"number"},"base_reward_currency_amount":{"type":"number"}}},"negotiable-quote-data-negotiable-quote-totals-interface":{"type":"object","description":"Extension attribute for quote totals model.","properties":{"items_count":{"type":"integer","description":"The number of different items or products in the cart."},"quote_status":{"type":"string","description":"Negotiable quote status."},"created_at":{"type":"string","description":"The cart creation date and time."},"updated_at":{"type":"string","description":"The cart last update date and time."},"customer_group":{"type":"integer","description":"Customer group id."},"base_to_quote_rate":{"type":"number","description":"Base currency to quote currency rate."},"cost_total":{"type":"number","description":"Total cost for quote."},"base_cost_total":{"type":"number","description":"Total cost for quote in base currency."},"original_total":{"type":"number","description":"Original quote total."},"base_original_total":{"type":"number","description":"Original quote total in base currency."},"original_tax":{"type":"number","description":"Original tax amount for quote."},"base_original_tax":{"type":"number","description":"Original tax amount for quote in base currency."},"original_price_incl_tax":{"type":"number","description":"Original price with included tax for quote."},"base_original_price_incl_tax":{"type":"number","description":"Original price with included tax for quote in base currency."},"negotiated_price_type":{"type":"integer","description":"Negotiable quote type."},"negotiated_price_value":{"type":"number","description":"Negotiable price value for quote."}},"required":["items_count","quote_status","created_at","updated_at","customer_group","base_to_quote_rate","cost_total","base_cost_total","original_total","base_original_total","original_tax","base_original_tax","original_price_incl_tax","base_original_price_incl_tax","negotiated_price_type","negotiated_price_value"]},"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"},"framework-search-search-result-interface":{"type":"object","description":"Interface SearchResultInterface","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"search_criteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","aggregations","search_criteria","total_count"]},"framework-search-document-interface":{"type":"object","description":"Interface \\Magento\\Framework\\Api\\Search\\DocumentInterface","properties":{"id":{"type":"integer"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucket_names":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucket_names"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"Interface \\Magento\\Framework\\Api\\Search\\AggregationValueInterface","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"Interface SearchCriteriaInterface","properties":{"request_name":{"type":"string"},"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["request_name","filter_groups"]},"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"}}},"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"}},"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"}}},"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"},"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"]},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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"}}},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-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"},"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-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transaction_id":{"type":"integer","description":"Transaction ID."},"parent_id":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"order_id":{"type":"integer","description":"Order ID."},"payment_id":{"type":"integer","description":"Payment ID."},"txn_id":{"type":"string","description":"Transaction business ID."},"parent_txn_id":{"type":"string","description":"Parent transaction business ID."},"txn_type":{"type":"string","description":"Transaction type."},"is_closed":{"type":"integer","description":"Is-closed flag value."},"additional_information":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"created_at":{"type":"string","description":"Created-at timestamp."},"child_transactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transaction_id","order_id","payment_id","txn_id","parent_txn_id","txn_type","is_closed","created_at","child_transactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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-payment-details-interface":{"type":"object","description":"Interface PaymentDetailsInterface","properties":{"payment_methods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extension_attributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["payment_methods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"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-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failed_items":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missing_items":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failed_items","missing_items"]},"checkout-agreements-data-agreement-interface":{"type":"object","description":"Interface AgreementInterface","properties":{"agreement_id":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"content_height":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkbox_text":{"type":"string","description":"Agreement checkbox text."},"is_active":{"type":"boolean","description":"Agreement status."},"is_html":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extension_attributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreement_id","name","content","checkbox_text","is_active","is_html","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-data-company-search-results-interface":{"type":"object","description":"Interface for company search results","properties":{"items":{"type":"array","description":"Companies list","items":{"$ref":"#/definitions/company-data-company-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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":{"quote_config":{"$ref":"#/definitions/negotiable-quote-data-company-quote-config-interface"},"applicable_payment_method":{"type":"integer"},"available_payment_methods":{"type":"string"},"use_config_settings":{"type":"integer"}}},"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-search-results-interface":{"type":"object","description":"Interface for company team search results","properties":{"items":{"type":"array","description":"Teams list","items":{"$ref":"#/definitions/company-data-team-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-hierarchy-interface":{"type":"object","description":"Company hierarchy DTO interface for WebAPI.","properties":{"structure_id":{"type":"integer","description":"Structure ID."},"entity_id":{"type":"integer","description":"Entity ID."},"entity_type":{"type":"string","description":"Entity type."},"structure_parent_id":{"type":"integer","description":"Structure parent ID."},"extension_attributes":{"$ref":"#/definitions/company-data-hierarchy-extension-interface"}}},"company-data-hierarchy-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\HierarchyInterface"},"company-data-role-search-results-interface":{"type":"object","description":"Interface for role search results.","properties":{"items":{"type":"array","description":"Roles list.","items":{"$ref":"#/definitions/company-data-role-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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 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"]},"shared-catalog-data-search-results-interface":{"type":"object","description":"Interface for Shared Catalog search results.","properties":{"items":{"type":"array","description":"Shared Catalog list.","items":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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","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"},"negotiable-quote-data-comment-interface":{"type":"object","description":"Interface CommentInterface","properties":{"entity_id":{"type":"integer","description":"Comment ID."},"parent_id":{"type":"integer","description":"Negotiable quote ID, that this comment belongs to."},"creator_type":{"type":"integer","description":"The comment creator type."},"is_decline":{"type":"integer","description":"Is quote was declined by seller."},"is_draft":{"type":"integer","description":"Is quote draft flag."},"creator_id":{"type":"integer","description":"Comment creator ID."},"comment":{"type":"string","description":"Comment."},"created_at":{"type":"string","description":"Comment created at."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-comment-extension-interface"},"attachments":{"type":"array","description":"Existing attachments.","items":{"$ref":"#/definitions/negotiable-quote-data-comment-attachment-interface"}}},"required":["entity_id","parent_id","creator_type","is_decline","is_draft","creator_id","comment","created_at","attachments"]},"negotiable-quote-data-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentInterface"},"negotiable-quote-data-comment-attachment-interface":{"type":"object","description":"Interface for quote comment attachment.","properties":{"attachment_id":{"type":"integer","description":"Attachment ID."},"comment_id":{"type":"integer","description":"Comment ID."},"file_name":{"type":"string","description":"File name."},"file_path":{"type":"string","description":"File path."},"file_type":{"type":"string","description":"File type."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-comment-attachment-extension-interface"}},"required":["attachment_id","comment_id","file_name","file_path","file_type"]},"negotiable-quote-data-comment-attachment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentAttachmentInterface"},"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"},"gift-wrapping-data-wrapping-search-results-interface":{"type":"object","description":"Interface WrappingSearchResultsInterface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-credit-limit-search-results-interface":{"type":"object","description":"Interface for Credit Limit search results.","properties":{"items":{"type":"array","description":"Credit Limit list.","items":{"$ref":"#/definitions/company-credit-data-credit-data-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-credit-data-interface":{"type":"object","description":"Credit Data 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."}},"required":["exceed_limit"]},"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"]},"company-credit-data-history-search-results-interface":{"type":"object","description":"Interface for History search results.","properties":{"items":{"type":"array","description":"History list.","items":{"$ref":"#/definitions/company-credit-data-history-data-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-history-data-interface":{"type":"object","description":"History data transfer object interface.","properties":{"id":{"type":"integer","description":"ID."},"company_credit_id":{"type":"integer","description":"Company credit id."},"user_id":{"type":"integer","description":"User Id."},"user_type":{"type":"integer","description":"User type: integration, admin, customer."},"currency_credit":{"type":"string","description":"Currency code of credit."},"currency_operation":{"type":"string","description":"Currency code of operation."},"rate":{"type":"number","description":"Currency rate between credit and operation currencies."},"rate_credit":{"type":"number","description":"Rate between credit and base currencies."},"amount":{"type":"number","description":"Amount."},"balance":{"type":"number","description":"Outstanding balance."},"credit_limit":{"type":"number","description":"Credit limit."},"available_limit":{"type":"number","description":"Available limit."},"type":{"type":"integer","description":"Type of operation."},"datetime":{"type":"string","description":"Operation datetime."},"purchase_order":{"type":"string","description":"Purchase Order number."},"comment":{"type":"string","description":"Comment."}},"required":["rate","amount","balance","credit_limit"]},"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-track-search-result-interface":{"type":"object","description":"Interface TrackSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-track-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"rma-data-comment-search-result-interface":{"type":"object","description":"Interface CommentSearchResultInterface","properties":{"items":{"type":"array","description":"Rma Status History list","items":{"$ref":"#/definitions/rma-data-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"rma-data-rma-search-result-interface":{"type":"object","description":"Interface RmaSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-rma-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"framework-metadata-object-interface":{"type":"object","description":"Provides metadata about an attribute.","properties":{"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["attribute_code"]}}} diff --git a/src/swagger/schemas/2.2.1.schema.json b/src/swagger/schemas/2.2.1.schema.json deleted file mode 100644 index ae8920dd52f..00000000000 --- a/src/swagger/schemas/2.2.1.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.2","title":"Magento Commerce for B2B 2.2"},"host":"hb.vg","basePath":"/rest/default","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerGroupConfigV1","description":"Interface for system configuration operations for customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogTierPriceStorageV1","description":"Tier prices storage."},{"name":"catalogBasePriceStorageV1","description":"Base prices storage."},{"name":"catalogCostStorageV1","description":"Product cost storage."},{"name":"catalogSpecialPriceStorageV1","description":"Special price storage presents efficient price API and is used to retrieve, update or delete special prices."},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogCategoryListV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":"Interface ProductWebsiteLinkRepositoryInterface"},{"name":"catalogProductRenderListV1","description":"Interface which provides product renders information for products"},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteGuestShipmentEstimationV1","description":"Interface GuestShipmentEstimationInterface"},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"requisitionListRequisitionListRepositoryV1","description":"Interface RequisitionListRepositoryInterface"},{"name":"searchV1","description":"Search API for all requests"},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesRefundInvoiceV1","description":"Interface RefundInvoiceInterface"},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesRefundOrderV1","description":"Interface RefundOrderInterface"},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesShipOrderV1","description":"Class ShipOrderInterface"},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"salesInvoiceOrderV1","description":"Class InvoiceOrderInterface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"companyCompanyRepositoryV1","description":"A repository interface for company entity that provides basic CRUD operations."},{"name":"companyTeamRepositoryV1","description":"Interface for basic CRUD operations for team entity."},{"name":"companyCompanyHierarchyV1","description":"Interface for working with company hierarchy."},{"name":"companyRoleRepositoryV1","description":"A repository interface for role entity that provides basic CRUD operations."},{"name":"companyAclV1","description":"Access control list interface."},{"name":"customerBalanceBalanceManagementV1","description":"Customer balance(store credit) operations"},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"},{"name":"sharedCatalogSharedCatalogRepositoryV1","description":""},{"name":"sharedCatalogCompanyManagementV1","description":"Shared catalog companies actions."},{"name":"sharedCatalogProductManagementV1","description":"Shared catalog products actions."},{"name":"sharedCatalogCategoryManagementV1","description":"Shared catalog products actions."},{"name":"giftCardAccountGiftCardAccountManagementV1","description":"Interface GiftCardAccountManagementInterface"},{"name":"giftCardAccountGuestGiftCardAccountManagementV1","description":"Interface GuestGiftCardAccountManagementInterface"},{"name":"negotiableQuoteNegotiableQuoteManagementV1","description":"Interface for managing quotes."},{"name":"negotiableQuoteNegotiableQuotePriceManagementV1","description":"Interface for updating quote prices in case price changes occur in system."},{"name":"negotiableQuoteAttachmentContentManagementV1","description":"Interface for retrieving the list of negotiable quotes attachments."},{"name":"negotiableQuoteCommentLocatorV1","description":"Interface for load quote comments with attachment."},{"name":"negotiableQuoteNegotiableQuoteShippingManagementV1","description":"Interface for add and update negotiable quote shipping method."},{"name":"negotiableQuotePaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"negotiableQuoteShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"negotiableQuoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"negotiableQuoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"negotiableQuoteNegotiableCartRepositoryV1","description":"Interface is intended to be used in webapi only. For other cases CartRepositoryInterface should be used."},{"name":"negotiableQuoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"negotiableQuoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"negotiableQuoteCouponManagementV1","description":"Coupon management service interface."},{"name":"negotiableQuoteGiftCardAccountManagementV1","description":"Interface GiftCardAccountManagementInterface"},{"name":"giftRegistryShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"giftRegistryGuestCartShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"},{"name":"giftWrappingWrappingRepositoryV1","description":"Interface WrappingRepositoryInterface"},{"name":"companyCreditCreditLimitRepositoryV1","description":"Interface for credit limit repository for CRUD operations."},{"name":"companyCreditCreditLimitManagementV1","description":"Credit Limit management interface."},{"name":"companyCreditCreditBalanceManagementV1","description":"Interface for management decrease and increase credit balance operations."},{"name":"companyCreditCreditHistoryManagementV1","description":"Update credit history log and retrieve history which match a specified criteria."},{"name":"rewardRewardManagementV1","description":"Interface RewardManagementInterface"},{"name":"rmaTrackManagementV1","description":"Interface TrackManagementInterface"},{"name":"rmaRmaRepositoryV1","description":"Interface RmaRepositoryInterface"},{"name":"rmaCommentManagementV1","description":"Interface CommentRepositoryInterface"},{"name":"rmaRmaManagementV1","description":"Interface RmaManagementInterface"},{"name":"rmaRmaAttributesManagementV1","description":"Interface RmaAttributesManagementInterface"},{"name":"worldpayGuestPaymentInformationManagementProxyV1","description":"Interface GuestPaymentInformationManagementProxyInterface"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{id}":{"put":{"tags":["customerCustomerGroupConfigV1"],"description":"Set system default customer group.","operationId":"customerCustomerGroupConfigV1SetDefaultCustomerGroupPut","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{id}":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","parameters":[{"name":"$body","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices-information":{"post":{"tags":["catalogTierPriceStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogTierPriceStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices":{"post":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices-delete":{"post":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/base-prices-information":{"post":{"tags":["catalogBasePriceStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogBasePriceStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-base-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/base-prices":{"post":{"tags":["catalogBasePriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-base-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost-information":{"post":{"tags":["catalogCostStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogCostStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-cost-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost":{"post":{"tags":["catalogCostStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-cost-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost-delete":{"post":{"tags":["catalogCostStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will return True if deleted."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price-information":{"post":{"tags":["catalogSpecialPriceStorageV1"],"description":"Return product's special price. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogSpecialPriceStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price":{"post":{"tags":["catalogSpecialPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price-delete":{"post":{"tags":["catalogSpecialPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/list":{"get":{"tags":["catalogCategoryListV1"],"description":"Get category list","operationId":"catalogCategoryListV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products-render-info":{"get":{"tags":["catalogProductRenderListV1"],"description":"Collect and retrieve the list of product render info This info contains raw prices and formated prices, product name, stock status, store_id, etc","operationId":"catalogProductRenderListV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."},{"name":"storeId","in":"query","type":"integer","required":true},{"name":"currencyCode","in":"query","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-render-search-results-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"put":{"tags":["quoteCartRepositoryV1"],"description":"Save quote","operationId":"quoteCartRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer if customer does not have a cart yet.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"new cart ID if customer did not have a cart or ID of the existing cart otherwise."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer if customer does not have a cart yet.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"new cart ID if customer did not have a cart or ID of the existing cart otherwise."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/items":{"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/requisition_lists":{"post":{"tags":["requisitionListRequisitionListRepositoryV1"],"description":"Save Requisition List","operationId":"requisitionListRequisitionListRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["requisitionList"],"properties":{"requisitionList":{"$ref":"#/definitions/requisition-list-data-requisition-list-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/requisition-list-data-requisition-list-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/create":{"put":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/":{"post":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"$body","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoice/{invoiceId}/refund":{"post":{"tags":["salesRefundInvoiceV1"],"description":"Create refund for invoice","operationId":"salesRefundInvoiceV1ExecutePost","parameters":[{"name":"invoiceId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/refund":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Prepare creditmemo to refund and save it.","operationId":"salesCreditmemoManagementV1RefundPost","parameters":[{"name":"$body","in":"body","schema":{"required":["creditmemo"],"properties":{"creditmemo":{"$ref":"#/definitions/sales-data-creditmemo-interface"},"offlineRequested":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/refund":{"post":{"tags":["salesRefundOrderV1"],"description":"Create offline refund for order","operationId":"salesRefundOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/ship":{"post":{"tags":["salesShipOrderV1"],"description":"Creates new Shipment for given Order.","operationId":"salesShipOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Id of created Shipment."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/invoice":{"post":{"tags":["salesInvoiceOrderV1"],"description":"","operationId":"salesInvoiceOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"$body","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"$body","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"$body","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Configurable product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/":{"get":{"tags":["companyCompanyRepositoryV1"],"description":"Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included.","operationId":"companyCompanyRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["companyCompanyRepositoryV1"],"description":"Create or update a company account.","operationId":"companyCompanyRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["company"],"properties":{"company":{"$ref":"#/definitions/company-data-company-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/{companyId}":{"get":{"tags":["companyCompanyRepositoryV1"],"description":"Returns company details.","operationId":"companyCompanyRepositoryV1GetGet","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyCompanyRepositoryV1"],"description":"Delete a company. Customers belonging to a company are not deleted with this request.","operationId":"companyCompanyRepositoryV1DeleteByIdDelete","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["companyCompanyRepositoryV1"],"description":"Create or update a company account.","operationId":"companyCompanyRepositoryV1SavePut","parameters":[{"name":"companyId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["company"],"properties":{"company":{"$ref":"#/definitions/company-data-company-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/":{"get":{"tags":["companyTeamRepositoryV1"],"description":"Returns the list of teams for the specified search criteria (team name or description).","operationId":"companyTeamRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-team-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/{teamId}":{"get":{"tags":["companyTeamRepositoryV1"],"description":"Returns data for a team in the company, by entity id.","operationId":"companyTeamRepositoryV1GetGet","parameters":[{"name":"teamId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-team-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyTeamRepositoryV1"],"description":"Delete a team from the company structure.","operationId":"companyTeamRepositoryV1DeleteByIdDelete","parameters":[{"name":"teamId","in":"path","type":"integer","required":true}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["companyTeamRepositoryV1"],"description":"Update a team in the company structure.","operationId":"companyTeamRepositoryV1SavePut","parameters":[{"name":"teamId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["team"],"properties":{"team":{"$ref":"#/definitions/company-data-team-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/{companyId}":{"post":{"tags":["companyTeamRepositoryV1"],"description":"Create a team in the company structure.","operationId":"companyTeamRepositoryV1CreatePost","parameters":[{"name":"companyId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["team"],"properties":{"team":{"$ref":"#/definitions/company-data-team-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/hierarchy/{id}":{"get":{"tags":["companyCompanyHierarchyV1"],"description":"Returns the list of teams and company users in the company structure.","operationId":"companyCompanyHierarchyV1GetCompanyHierarchyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/company-data-hierarchy-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/hierarchy/move/{id}":{"put":{"tags":["companyCompanyHierarchyV1"],"description":"Moves teams and users within the company structure.","operationId":"companyCompanyHierarchyV1MoveNodePut","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["newParentId"],"properties":{"newParentId":{"type":"integer"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/":{"get":{"tags":["companyRoleRepositoryV1"],"description":"Returns the list of roles and permissions for a specified company.","operationId":"companyRoleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["companyRoleRepositoryV1"],"description":"Create or update a role for a selected company.","operationId":"companyRoleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["role"],"properties":{"role":{"$ref":"#/definitions/company-data-role-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{roleId}":{"get":{"tags":["companyRoleRepositoryV1"],"description":"Returns the list of permissions for a specified role.","operationId":"companyRoleRepositoryV1GetGet","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyRoleRepositoryV1"],"description":"Delete a role.","operationId":"companyRoleRepositoryV1DeleteDelete","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{id}":{"put":{"tags":["companyRoleRepositoryV1"],"description":"Create or update a role for a selected company.","operationId":"companyRoleRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["role"],"properties":{"role":{"$ref":"#/definitions/company-data-role-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/assignRoles":{"put":{"tags":["companyAclV1"],"description":"Change a role for a company user.","operationId":"companyAclV1AssignRolesPut","parameters":[{"name":"$body","in":"body","schema":{"required":["userId","roles"],"properties":{"userId":{"type":"integer"},"roles":{"type":"array","items":{"$ref":"#/definitions/company-data-role-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{roleId}/users":{"get":{"tags":["companyAclV1"],"description":"View the list of company users assigned to a specified role.","operationId":"companyAclV1GetUsersByRoleIdGet","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-customer-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/balance/apply":{"post":{"tags":["customerBalanceBalanceManagementV1"],"description":"Apply store credit","operationId":"customerBalanceBalanceManagementV1ApplyPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}":{"get":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Return the following properties for the selected shared catalog: ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.","operationId":"sharedCatalogSharedCatalogRepositoryV1GetGet","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Delete a shared catalog by ID.","operationId":"sharedCatalogSharedCatalogRepositoryV1DeleteByIdDelete","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog":{"post":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Create or update Shared Catalog service.","operationId":"sharedCatalogSharedCatalogRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["sharedCatalog"],"properties":{"sharedCatalog":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}":{"put":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Create or update Shared Catalog service.","operationId":"sharedCatalogSharedCatalogRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sharedCatalog"],"properties":{"sharedCatalog":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/":{"get":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Return the list of shared catalogs and basic properties for each catalog.","operationId":"sharedCatalogSharedCatalogRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/shared-catalog-data-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/companies":{"get":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Return the list of company IDs for the companies assigned to the selected catalog.","operationId":"sharedCatalogCompanyManagementV1GetCompaniesGet","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/assignCompanies":{"post":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Assign companies to a shared catalog.","operationId":"sharedCatalogCompanyManagementV1AssignCompaniesPost","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["companies"],"properties":{"companies":{"type":"array","items":{"$ref":"#/definitions/company-data-company-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/unassignCompanies":{"post":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Unassign companies from a shared catalog.","operationId":"sharedCatalogCompanyManagementV1UnassignCompaniesPost","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["companies"],"properties":{"companies":{"type":"array","items":{"$ref":"#/definitions/company-data-company-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/products":{"get":{"tags":["sharedCatalogProductManagementV1"],"description":"Return the list of product SKUs in the selected shared catalog.","operationId":"sharedCatalogProductManagementV1GetProductsGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/assignProducts":{"post":{"tags":["sharedCatalogProductManagementV1"],"description":"Add products into the shared catalog.","operationId":"sharedCatalogProductManagementV1AssignProductsPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/unassignProducts":{"post":{"tags":["sharedCatalogProductManagementV1"],"description":"Remove the specified products from the shared catalog.","operationId":"sharedCatalogProductManagementV1UnassignProductsPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/categories":{"get":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Return the list of categories in the selected shared catalog.","operationId":"sharedCatalogCategoryManagementV1GetCategoriesGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"integer"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/assignCategories":{"post":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Add categories into the shared catalog.","operationId":"sharedCatalogCategoryManagementV1AssignCategoriesPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["categories"],"properties":{"categories":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/unassignCategories":{"post":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Remove the specified categories from the shared catalog.","operationId":"sharedCatalogCategoryManagementV1UnassignCategoriesPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["categories"],"properties":{"categories":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/giftCards":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Return GiftCard Account cards","operationId":"giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards":{"put":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards":{"post":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards":{"post":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/request":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/submitToCustomer":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/decline":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["quoteId","reason"],"properties":{"quoteId":{"type":"integer"},"reason":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/pricesUpdated":{"post":{"tags":["negotiableQuoteNegotiableQuotePriceManagementV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["quoteIds"],"properties":{"quoteIds":{"type":"array","items":{"type":"integer"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/attachmentContent":{"get":{"tags":["negotiableQuoteAttachmentContentManagementV1"],"description":"Returns content for one or more files attached on the quote comment.","operationId":"negotiableQuoteAttachmentContentManagementV1GetGet","parameters":[{"name":"attachmentIds","in":"query","type":"array","items":{"type":"integer"},"required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/negotiable-quote-data-attachment-content-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}/comments":{"get":{"tags":["negotiableQuoteCommentLocatorV1"],"description":"Returns comments for a specified negotiable quote.","operationId":"negotiableQuoteCommentLocatorV1GetListForQuoteGet","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true,"description":"Negotiable Quote ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of quote comments.","items":{"$ref":"#/definitions/negotiable-quote-data-comment-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}/shippingMethod":{"put":{"tags":["negotiableQuoteNegotiableQuoteShippingManagementV1"],"description":"Updates the shipping method on a negotiable quote.","operationId":"negotiableQuoteNegotiableQuoteShippingManagementV1SetShippingMethodPut","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true,"description":"Negotiable Quote id"},{"name":"$body","in":"body","schema":{"required":["shippingMethod"],"properties":{"shippingMethod":{"type":"string","description":"The shipping method code."}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/payment-information":{"post":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Get payment information","operationId":"negotiableQuotePaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/set-payment-information":{"post":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/shipping-information":{"post":{"tags":["negotiableQuoteShippingInformationManagementV1"],"description":"","operationId":"negotiableQuoteShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["negotiableQuoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["negotiableQuoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}":{"put":{"tags":["negotiableQuoteNegotiableCartRepositoryV1"],"description":"Save quote","operationId":"negotiableQuoteNegotiableCartRepositoryV1SavePut","parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/billing-address":{"get":{"tags":["negotiableQuoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"negotiableQuoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["negotiableQuoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"negotiableQuoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/totals":{"get":{"tags":["negotiableQuoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"negotiableQuoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["negotiableQuoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"negotiableQuoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/coupons":{"delete":{"tags":["negotiableQuoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"negotiableQuoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/giftCards":{"post":{"tags":["negotiableQuoteGiftCardAccountManagementV1"],"description":"","operationId":"negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["negotiableQuoteGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"negotiableQuoteGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/giftregistry/mine/estimate-shipping-methods":{"post":{"tags":["giftRegistryShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":{"post":{"tags":["giftRegistryGuestCartShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{id}":{"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return data object for specified wrapping ID and store.","operationId":"giftWrappingWrappingRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Delete gift wrapping","operationId":"giftWrappingWrappingRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings":{"post":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return list of gift wrapping data objects based on search criteria","operationId":"giftWrappingWrappingRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{wrappingId}":{"put":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePut","parameters":[{"name":"wrappingId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/":{"get":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Returns the list of credits for specified companies.","operationId":"companyCreditCreditLimitRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}":{"get":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Returns data on the credit limit for a specified credit limit ID.","operationId":"companyCreditCreditLimitRepositoryV1GetGet","parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"reload","in":"query","type":"boolean","description":"[optional]","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{id}":{"put":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Update the following company credit attributes: credit currency, credit limit and setting to exceed credit.","operationId":"companyCreditCreditLimitRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["creditLimit"],"properties":{"creditLimit":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/company/{companyId}":{"get":{"tags":["companyCreditCreditLimitManagementV1"],"description":"Returns data on the credit limit for a specified company.","operationId":"companyCreditCreditLimitManagementV1GetCreditByCompanyIdGet","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}/increaseBalance":{"post":{"tags":["companyCreditCreditBalanceManagementV1"],"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","parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}/decreaseBalance":{"post":{"tags":["companyCreditCreditBalanceManagementV1"],"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","parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/history":{"get":{"tags":["companyCreditCreditHistoryManagementV1"],"description":"Returns the credit history for one or more companies.","operationId":"companyCreditCreditHistoryManagementV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-history-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/history/{historyId}":{"put":{"tags":["companyCreditCreditHistoryManagementV1"],"description":"Update the PO Number and/or comment for a Reimburse transaction.","operationId":"companyCreditCreditHistoryManagementV1UpdatePut","parameters":[{"name":"historyId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"properties":{"purchaseOrder":{"type":"string","description":"[optional]"},"comment":{"type":"string","description":"[optional]"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/reward/mine/use-reward":{"post":{"tags":["rewardRewardManagementV1"],"description":"Set reward points to quote","operationId":"rewardRewardManagementV1SetPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers":{"post":{"tags":["rmaTrackManagementV1"],"description":"Add track","operationId":"rmaTrackManagementV1AddTrackPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["track"],"properties":{"track":{"$ref":"#/definitions/rma-data-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaTrackManagementV1"],"description":"Get track list","operationId":"rmaTrackManagementV1GetTracksGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-track-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers/{trackId}":{"delete":{"tags":["rmaTrackManagementV1"],"description":"Remove track by id","operationId":"rmaTrackManagementV1RemoveTrackByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"trackId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/labels":{"get":{"tags":["rmaTrackManagementV1"],"description":"Get shipping label int the PDF format","operationId":"rmaTrackManagementV1GetShippingLabelPdfGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}":{"get":{"tags":["rmaRmaRepositoryV1"],"description":"Return data object for specified RMA id","operationId":"rmaRmaRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["rmaRmaRepositoryV1"],"description":"Delete RMA","operationId":"rmaRmaRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/comments":{"post":{"tags":["rmaCommentManagementV1"],"description":"Add comment","operationId":"rmaCommentManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/rma-data-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaCommentManagementV1"],"description":"Comments list","operationId":"rmaCommentManagementV1CommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns":{"post":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPost","parameters":[{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaRmaManagementV1"],"description":"Return list of rma data objects based on search criteria","operationId":"rmaRmaManagementV1SearchGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/{attributeCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/form/{formCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve all attributes filtered by form code","operationId":"rmaRmaAttributesManagementV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get all attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/custom":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get custom attribute metadata for the given Data object's attribute set","operationId":"rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataObjectClassName","in":"query","type":"string","description":"Data object class name","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/framework-metadata-object-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/worldpay-guest-carts/{cartId}/payment-information":{"post":{"tags":["worldpayGuestPaymentInformationManagementProxyV1"],"description":"Proxy handler for guest place order","operationId":"worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"website_id":{"type":"integer"},"store_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","website_id","store_group_id"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"website_id":{"type":"integer"},"root_category_id":{"type":"integer"},"default_store_id":{"type":"integer"},"name":{"type":"string"},"code":{"type":"string","description":"Group code."},"extension_attributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","website_id","root_category_id","default_store_id","name","code"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"default_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","default_group_id"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"website_id":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"base_currency_code":{"type":"string","description":"Base currency code"},"default_display_currency_code":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weight_unit":{"type":"string","description":"The unit of weight"},"base_url":{"type":"string","description":"Base URL for the store"},"base_link_url":{"type":"string","description":"Base link URL for the store"},"base_static_url":{"type":"string","description":"Base static URL for the store"},"base_media_url":{"type":"string","description":"Base media URL for the store"},"secure_base_url":{"type":"string","description":"Secure base URL for the store"},"secure_base_link_url":{"type":"string","description":"Secure base link URL for the store"},"secure_base_static_url":{"type":"string","description":"Secure base static URL for the store"},"secure_base_media_url":{"type":"string","description":"Secure base media URL for the store"},"extension_attributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","website_id","locale","base_currency_code","default_display_currency_code","timezone","weight_unit","base_url","base_link_url","base_static_url","base_media_url","secure_base_url","secure_base_link_url","secure_base_static_url","secure_base_media_url"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"base_currency_code":{"type":"string","description":"The base currency code for the store."},"base_currency_symbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"default_display_currency_code":{"type":"string","description":"The default display currency code for the store."},"default_display_currency_symbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"available_currency_codes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchange_rates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["base_currency_code","base_currency_symbol","default_display_currency_code","default_display_currency_symbol","available_currency_codes","exchange_rates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currency_to":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extension_attributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currency_to","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"two_letter_abbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"three_letter_abbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"full_name_locale":{"type":"string","description":"The country full name (in store locale) for the store."},"full_name_english":{"type":"string","description":"The country full name (in English) for the store."},"available_regions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","two_letter_abbreviation","three_letter_abbreviation","full_name_locale","full_name_english"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extension_attributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"Interface AttributeSetSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["filter_groups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"condition_type":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"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-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontend_input":{"type":"string","description":"HTML for input element."},"input_filter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"store_label":{"type":"string","description":"Label of the store."},"validation_rules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multiline_count":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"data_model":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontend_class":{"type":"string","description":"Class which is used to display the attribute on frontend."},"user_defined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sort_order":{"type":"integer","description":"Attributes sort order."},"frontend_label":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backend_type":{"type":"string","description":"Backend type."},"is_used_in_grid":{"type":"boolean","description":"It is used in customer grid"},"is_visible_in_grid":{"type":"boolean","description":"It is visible in customer grid"},"is_filterable_in_grid":{"type":"boolean","description":"It is filterable in customer grid"},"is_searchable_in_grid":{"type":"boolean","description":"It is searchable in customer grid"},"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["frontend_input","input_filter","store_label","validation_rules","multiline_count","visible","required","data_model","options","frontend_class","user_defined","sort_order","frontend_label","note","system","backend_type","attribute_code"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"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"}}},"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"},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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"},"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-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"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"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"Interface AttributeGroupSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-price-update-result-interface":{"type":"object","description":"Interface returned in case of incorrect price passed to efficient price API.","properties":{"message":{"type":"string","description":"Error message, that contains description of error occurred during price update."},"parameters":{"type":"array","description":"Parameters, that could be displayed in error message placeholders.","items":{"type":"string"}},"extension_attributes":{"$ref":"#/definitions/catalog-data-price-update-result-extension-interface"}},"required":["message","parameters"]},"catalog-data-price-update-result-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface"},"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":"","properties":{"id":{"type":"integer"},"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"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"path":{"type":"string"},"available_sort_by":{"type":"array","items":{"type":"string"}},"include_in_menu":{"type":"boolean"},"extension_attributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"product_count":{"type":"integer","description":"Product count"},"children_data":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parent_id","name","is_active","position","level","product_count","children_data"]},"catalog-data-category-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Categories","items":{"$ref":"#/definitions/catalog-data-category-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"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"]},"catalog-data-product-render-search-results-interface":{"type":"object","description":"Dto that holds render information about products","properties":{"items":{"type":"array","description":"List of products rendered information","items":{"$ref":"#/definitions/catalog-data-product-render-interface"}}},"required":["items"]},"catalog-data-product-render-interface":{"type":"object","description":"Represents Data Object which holds enough information to render product This information is put into part as Add To Cart or Add to Compare Data or Price Data","properties":{"add_to_cart_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"add_to_compare_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"price_info":{"$ref":"#/definitions/catalog-data-product-render-price-info-interface"},"images":{"type":"array","description":"Enough information, that needed to render image on front","items":{"$ref":"#/definitions/catalog-data-product-render-image-interface"}},"url":{"type":"string","description":"Product url"},"id":{"type":"integer","description":"Product identifier"},"name":{"type":"string","description":"Product name"},"type":{"type":"string","description":"Product type. Such as bundle, grouped, simple, etc..."},"is_salable":{"type":"string","description":"Information about product saleability (In Stock)"},"store_id":{"type":"integer","description":"Information about current store id or requested store id"},"currency_code":{"type":"string","description":"Current or desired currency code to product"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-extension-interface"}},"required":["add_to_cart_button","add_to_compare_button","price_info","images","url","id","name","type","is_salable","store_id","currency_code","extension_attributes"]},"catalog-data-product-render-button-interface":{"type":"object","description":"Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend","properties":{"post_data":{"type":"string","description":"Post data"},"url":{"type":"string","description":"Url, needed to add product to cart"},"required_options":{"type":"boolean","description":"Flag whether a product has options or not"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-button-extension-interface"}},"required":["post_data","url","required_options"]},"catalog-data-product-render-button-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ButtonInterface"},"catalog-data-product-render-price-info-interface":{"type":"object","description":"Price interface.","properties":{"final_price":{"type":"number","description":"Final price"},"max_price":{"type":"number","description":"Max price of a product"},"max_regular_price":{"type":"number","description":"Max regular price"},"minimal_regular_price":{"type":"number","description":"Minimal regular price"},"special_price":{"type":"number","description":"Special price"},"minimal_price":{"type":"number"},"regular_price":{"type":"number","description":"Regular price"},"formatted_prices":{"$ref":"#/definitions/catalog-data-product-render-formatted-price-info-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-price-info-extension-interface"}},"required":["final_price","max_price","max_regular_price","minimal_regular_price","special_price","minimal_price","regular_price","formatted_prices"]},"catalog-data-product-render-formatted-price-info-interface":{"type":"object","description":"Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html","properties":{"final_price":{"type":"string","description":"Html with final price"},"max_price":{"type":"string","description":"Max price of a product"},"minimal_price":{"type":"string","description":"The minimal price of the product or variation"},"max_regular_price":{"type":"string","description":"Max regular price"},"minimal_regular_price":{"type":"string","description":"Minimal regular price"},"special_price":{"type":"string","description":"Special price"},"regular_price":{"type":"string","description":"Price - is price of product without discounts and special price with taxes and fixed product tax"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-formatted-price-info-extension-interface"}},"required":["final_price","max_price","minimal_price","max_regular_price","minimal_regular_price","special_price","regular_price"]},"catalog-data-product-render-formatted-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\FormattedPriceInfoInterface"},"catalog-data-product-render-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\PriceInfoInterface","properties":{"msrp":{"$ref":"#/definitions/msrp-data-product-render-msrp-price-info-interface"},"tax_adjustments":{"$ref":"#/definitions/catalog-data-product-render-price-info-interface"},"weee_attributes":{"type":"array","items":{"$ref":"#/definitions/weee-data-product-render-weee-adjustment-attribute-interface"}},"weee_adjustment":{"type":"string"}}},"msrp-data-product-render-msrp-price-info-interface":{"type":"object","description":"Price interface.","properties":{"msrp_price":{"type":"string"},"is_applicable":{"type":"string"},"is_shown_price_on_gesture":{"type":"string"},"msrp_message":{"type":"string"},"explanation_message":{"type":"string"},"extension_attributes":{"$ref":"#/definitions/msrp-data-product-render-msrp-price-info-extension-interface"}},"required":["msrp_price","is_applicable","is_shown_price_on_gesture","msrp_message","explanation_message"]},"msrp-data-product-render-msrp-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Msrp\\Api\\Data\\ProductRender\\MsrpPriceInfoInterface"},"weee-data-product-render-weee-adjustment-attribute-interface":{"type":"object","description":"List of all weee attributes, their amounts, etc.., that product has","properties":{"amount":{"type":"string","description":"Weee attribute amount"},"tax_amount":{"type":"string","description":"Tax which is calculated to fixed product tax attribute"},"tax_amount_incl_tax":{"type":"string","description":"Tax amount of weee attribute"},"amount_excl_tax":{"type":"string","description":"Product amount exclude tax"},"attribute_code":{"type":"string","description":"Weee attribute code"},"extension_attributes":{"$ref":"#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface"}},"required":["amount","tax_amount","tax_amount_incl_tax","amount_excl_tax","attribute_code","extension_attributes"]},"weee-data-product-render-weee-adjustment-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Weee\\Api\\Data\\ProductRender\\WeeeAdjustmentAttributeInterface"},"catalog-data-product-render-image-interface":{"type":"object","description":"Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view","properties":{"url":{"type":"string","description":"Image url"},"code":{"type":"string","description":"Image code"},"height":{"type":"number","description":"Image height"},"width":{"type":"number","description":"Image width in px"},"label":{"type":"string","description":"Image label"},"resized_width":{"type":"number","description":"Resize width"},"resized_height":{"type":"number","description":"Resize height"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-image-extension-interface"}},"required":["url","code","height","width","label","resized_width","resized_height"]},"catalog-data-product-render-image-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ImageInterface"},"catalog-data-product-render-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRenderInterface","properties":{"wishlist_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"review_html":{"type":"string"}}},"catalog-inventory-data-stock-status-collection-interface":{"type":"object","description":"Stock Status collection interface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"search_criteria":{"$ref":"#/definitions/catalog-inventory-stock-status-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"product_id":{"type":"integer"},"stock_id":{"type":"integer"},"qty":{"type":"integer"},"stock_status":{"type":"integer"},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["product_id","stock_id","qty","stock_status","stock_item"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"catalog-inventory-stock-status-criteria-interface":{"type":"object","description":"Interface StockStatusCriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extension_attributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"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":"integer","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"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface","properties":{"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-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":{"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"}}},"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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrier_code":{"type":"string","description":"Shipping carrier code."},"method_code":{"type":"string","description":"Shipping method code."},"carrier_title":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"method_title":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"base_amount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"error_message":{"type":"string","description":"Shipping Error message."},"price_excl_tax":{"type":"number","description":"Shipping price excl tax."},"price_incl_tax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrier_code","method_code","amount","base_amount","available","error_message","price_excl_tax","price_incl_tax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grand_total":{"type":"number","description":"Grand total in quote currency"},"base_grand_total":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"base_subtotal":{"type":"number","description":"Subtotal in base currency"},"discount_amount":{"type":"number","description":"Discount amount in quote currency"},"base_discount_amount":{"type":"number","description":"Discount amount in base currency"},"subtotal_with_discount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"base_subtotal_with_discount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shipping_amount":{"type":"number","description":"Shipping amount in quote currency"},"base_shipping_amount":{"type":"number","description":"Shipping amount in base currency"},"shipping_discount_amount":{"type":"number","description":"Shipping discount amount in quote currency"},"base_shipping_discount_amount":{"type":"number","description":"Shipping discount amount in base currency"},"tax_amount":{"type":"number","description":"Tax amount in quote currency"},"base_tax_amount":{"type":"number","description":"Tax amount in base currency"},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount in quote currency"},"base_shipping_tax_amount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in quote currency"},"base_subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in base currency"},"shipping_incl_tax":{"type":"number","description":"Shipping including tax in quote currency"},"base_shipping_incl_tax":{"type":"number","description":"Shipping including tax in base currency"},"base_currency_code":{"type":"string","description":"Base currency code"},"quote_currency_code":{"type":"string","description":"Quote currency code"},"coupon_code":{"type":"string","description":"Applied coupon code"},"items_qty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"total_segments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weee_tax_applied_amount","total_segments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"item_id":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"base_price":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"row_total":{"type":"number","description":"Row total in quote currency."},"base_row_total":{"type":"number","description":"Row total in base currency."},"row_total_with_discount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"tax_amount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"base_tax_amount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"tax_percent":{"type":"number","description":"Tax percent. Otherwise, null."},"discount_amount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"base_discount_amount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discount_percent":{"type":"number","description":"Discount percent. Otherwise, null."},"price_incl_tax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"base_price_incl_tax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"row_total_incl_tax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"base_row_total_incl_tax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weee_tax_applied":{"type":"string","description":"Item weee tax applied in quote currency."},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["item_id","price","base_price","qty","row_total","base_row_total","options","weee_tax_applied_amount","weee_tax_applied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface","properties":{"negotiable_quote_item_totals":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface"}}},"negotiable-quote-data-negotiable-quote-item-totals-interface":{"type":"object","description":"Extension attribute for quote item totals model.","properties":{"cost":{"type":"number","description":"Cost for quote item."},"catalog_price":{"type":"number","description":"Catalog price for quote item."},"base_catalog_price":{"type":"number","description":"Catalog price for quote item in base currency."},"catalog_price_incl_tax":{"type":"number","description":"Catalog price with included tax for quote item."},"base_catalog_price_incl_tax":{"type":"number","description":"Catalog price with included tax for quote item in base currency."},"cart_price":{"type":"number","description":"Cart price for quote item."},"base_cart_price":{"type":"number","description":"Cart price for quote item in base currency."},"cart_tax":{"type":"number","description":"Tax from catalog price for quote item."},"base_cart_tax":{"type":"number","description":"Tax from catalog price for quote item in base currency."},"cart_price_incl_tax":{"type":"number","description":"Cart price with included tax for quote item."},"base_cart_price_incl_tax":{"type":"number","description":"Cart price with included tax for quote item in base currency."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface"}},"required":["cost","catalog_price","base_catalog_price","catalog_price_incl_tax","base_catalog_price_incl_tax","cart_price","base_cart_price","cart_tax","base_cart_tax","cart_price_incl_tax","base_cart_price_incl_tax"]},"negotiable-quote-data-negotiable-quote-item-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteItemTotalsInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extension_attributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"tax_grandtotal_details":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}},"gift_cards":{"type":"string"},"gw_order_id":{"type":"string"},"gw_item_ids":{"type":"array","items":{"type":"string"}},"gw_allow_gift_receipt":{"type":"string"},"gw_add_card":{"type":"string"},"gw_price":{"type":"string"},"gw_base_price":{"type":"string"},"gw_items_price":{"type":"string"},"gw_items_base_price":{"type":"string"},"gw_card_price":{"type":"string"},"gw_card_base_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_price_incl_tax":{"type":"string"},"gw_base_price_incl_tax":{"type":"string"},"gw_card_price_incl_tax":{"type":"string"},"gw_card_base_price_incl_tax":{"type":"string"},"gw_items_price_incl_tax":{"type":"string"},"gw_items_base_price_incl_tax":{"type":"string"}}},"tax-data-grand-total-details-interface":{"type":"object","description":"Interface GrandTotalDetailsInterface","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"group_id":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","group_id"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"Interface GrandTotalRatesInterface","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface","properties":{"coupon_label":{"type":"string"},"base_customer_balance_amount":{"type":"number"},"customer_balance_amount":{"type":"number"},"negotiable_quote_totals":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-totals-interface"},"reward_points_balance":{"type":"number"},"reward_currency_amount":{"type":"number"},"base_reward_currency_amount":{"type":"number"}}},"negotiable-quote-data-negotiable-quote-totals-interface":{"type":"object","description":"Extension attribute for quote totals model.","properties":{"items_count":{"type":"integer","description":"The number of different items or products in the cart."},"quote_status":{"type":"string","description":"Negotiable quote status."},"created_at":{"type":"string","description":"The cart creation date and time."},"updated_at":{"type":"string","description":"The cart last update date and time."},"customer_group":{"type":"integer","description":"Customer group id."},"base_to_quote_rate":{"type":"number","description":"Base currency to quote currency rate."},"cost_total":{"type":"number","description":"Total cost for quote."},"base_cost_total":{"type":"number","description":"Total cost for quote in base currency."},"original_total":{"type":"number","description":"Original quote total."},"base_original_total":{"type":"number","description":"Original quote total in base currency."},"original_tax":{"type":"number","description":"Original tax amount for quote."},"base_original_tax":{"type":"number","description":"Original tax amount for quote in base currency."},"original_price_incl_tax":{"type":"number","description":"Original price with included tax for quote."},"base_original_price_incl_tax":{"type":"number","description":"Original price with included tax for quote in base currency."},"negotiated_price_type":{"type":"integer","description":"Negotiable quote type."},"negotiated_price_value":{"type":"number","description":"Negotiable price value for quote."}},"required":["items_count","quote_status","created_at","updated_at","customer_group","base_to_quote_rate","cost_total","base_cost_total","original_total","base_original_total","original_tax","base_original_tax","original_price_incl_tax","base_original_price_incl_tax","negotiated_price_type","negotiated_price_value"]},"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"},"framework-search-search-result-interface":{"type":"object","description":"Interface SearchResultInterface","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"search_criteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","aggregations","search_criteria","total_count"]},"framework-search-document-interface":{"type":"object","description":"Interface \\Magento\\Framework\\Api\\Search\\DocumentInterface","properties":{"id":{"type":"integer"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucket_names":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucket_names"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"Interface \\Magento\\Framework\\Api\\Search\\AggregationValueInterface","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"Interface SearchCriteriaInterface","properties":{"request_name":{"type":"string"},"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["request_name","filter_groups"]},"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"}}},"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"}},"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"}}},"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"},"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"]},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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"}}},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-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"},"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-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transaction_id":{"type":"integer","description":"Transaction ID."},"parent_id":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"order_id":{"type":"integer","description":"Order ID."},"payment_id":{"type":"integer","description":"Payment ID."},"txn_id":{"type":"string","description":"Transaction business ID."},"parent_txn_id":{"type":"string","description":"Parent transaction business ID."},"txn_type":{"type":"string","description":"Transaction type."},"is_closed":{"type":"integer","description":"Is-closed flag value."},"additional_information":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"created_at":{"type":"string","description":"Created-at timestamp."},"child_transactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transaction_id","order_id","payment_id","txn_id","parent_txn_id","txn_type","is_closed","created_at","child_transactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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-payment-details-interface":{"type":"object","description":"Interface PaymentDetailsInterface","properties":{"payment_methods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extension_attributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["payment_methods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"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-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failed_items":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missing_items":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failed_items","missing_items"]},"checkout-agreements-data-agreement-interface":{"type":"object","description":"Interface AgreementInterface","properties":{"agreement_id":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"content_height":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkbox_text":{"type":"string","description":"Agreement checkbox text."},"is_active":{"type":"boolean","description":"Agreement status."},"is_html":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extension_attributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreement_id","name","content","checkbox_text","is_active","is_html","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-data-company-search-results-interface":{"type":"object","description":"Interface for company search results","properties":{"items":{"type":"array","description":"Companies list","items":{"$ref":"#/definitions/company-data-company-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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":{"quote_config":{"$ref":"#/definitions/negotiable-quote-data-company-quote-config-interface"},"applicable_payment_method":{"type":"integer"},"available_payment_methods":{"type":"string"},"use_config_settings":{"type":"integer"}}},"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-search-results-interface":{"type":"object","description":"Interface for company team search results","properties":{"items":{"type":"array","description":"Teams list","items":{"$ref":"#/definitions/company-data-team-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-hierarchy-interface":{"type":"object","description":"Company hierarchy DTO interface for WebAPI.","properties":{"structure_id":{"type":"integer","description":"Structure ID."},"entity_id":{"type":"integer","description":"Entity ID."},"entity_type":{"type":"string","description":"Entity type."},"structure_parent_id":{"type":"integer","description":"Structure parent ID."},"extension_attributes":{"$ref":"#/definitions/company-data-hierarchy-extension-interface"}}},"company-data-hierarchy-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\HierarchyInterface"},"company-data-role-search-results-interface":{"type":"object","description":"Interface for role search results.","properties":{"items":{"type":"array","description":"Roles list.","items":{"$ref":"#/definitions/company-data-role-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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 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"]},"shared-catalog-data-search-results-interface":{"type":"object","description":"Interface for Shared Catalog search results.","properties":{"items":{"type":"array","description":"Shared Catalog list.","items":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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","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"},"negotiable-quote-data-comment-interface":{"type":"object","description":"Interface CommentInterface","properties":{"entity_id":{"type":"integer","description":"Comment ID."},"parent_id":{"type":"integer","description":"Negotiable quote ID, that this comment belongs to."},"creator_type":{"type":"integer","description":"The comment creator type."},"is_decline":{"type":"integer","description":"Is quote was declined by seller."},"is_draft":{"type":"integer","description":"Is quote draft flag."},"creator_id":{"type":"integer","description":"Comment creator ID."},"comment":{"type":"string","description":"Comment."},"created_at":{"type":"string","description":"Comment created at."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-comment-extension-interface"},"attachments":{"type":"array","description":"Existing attachments.","items":{"$ref":"#/definitions/negotiable-quote-data-comment-attachment-interface"}}},"required":["entity_id","parent_id","creator_type","is_decline","is_draft","creator_id","comment","created_at","attachments"]},"negotiable-quote-data-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentInterface"},"negotiable-quote-data-comment-attachment-interface":{"type":"object","description":"Interface for quote comment attachment.","properties":{"attachment_id":{"type":"integer","description":"Attachment ID."},"comment_id":{"type":"integer","description":"Comment ID."},"file_name":{"type":"string","description":"File name."},"file_path":{"type":"string","description":"File path."},"file_type":{"type":"string","description":"File type."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-comment-attachment-extension-interface"}},"required":["attachment_id","comment_id","file_name","file_path","file_type"]},"negotiable-quote-data-comment-attachment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentAttachmentInterface"},"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"},"gift-wrapping-data-wrapping-search-results-interface":{"type":"object","description":"Interface WrappingSearchResultsInterface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-credit-limit-search-results-interface":{"type":"object","description":"Interface for Credit Limit search results.","properties":{"items":{"type":"array","description":"Credit Limit list.","items":{"$ref":"#/definitions/company-credit-data-credit-data-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-credit-data-interface":{"type":"object","description":"Credit Data 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."}},"required":["exceed_limit"]},"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"]},"company-credit-data-history-search-results-interface":{"type":"object","description":"Interface for History search results.","properties":{"items":{"type":"array","description":"History list.","items":{"$ref":"#/definitions/company-credit-data-history-data-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-history-data-interface":{"type":"object","description":"History data transfer object interface.","properties":{"id":{"type":"integer","description":"ID."},"company_credit_id":{"type":"integer","description":"Company credit id."},"user_id":{"type":"integer","description":"User Id."},"user_type":{"type":"integer","description":"User type: integration, admin, customer."},"currency_credit":{"type":"string","description":"Currency code of credit."},"currency_operation":{"type":"string","description":"Currency code of operation."},"rate":{"type":"number","description":"Currency rate between credit and operation currencies."},"rate_credit":{"type":"number","description":"Rate between credit and base currencies."},"amount":{"type":"number","description":"Amount."},"balance":{"type":"number","description":"Outstanding balance."},"credit_limit":{"type":"number","description":"Credit limit."},"available_limit":{"type":"number","description":"Available limit."},"type":{"type":"integer","description":"Type of operation."},"datetime":{"type":"string","description":"Operation datetime."},"purchase_order":{"type":"string","description":"Purchase Order number."},"comment":{"type":"string","description":"Comment."}},"required":["rate","amount","balance","credit_limit"]},"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-track-search-result-interface":{"type":"object","description":"Interface TrackSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-track-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"rma-data-comment-search-result-interface":{"type":"object","description":"Interface CommentSearchResultInterface","properties":{"items":{"type":"array","description":"Rma Status History list","items":{"$ref":"#/definitions/rma-data-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"rma-data-rma-search-result-interface":{"type":"object","description":"Interface RmaSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-rma-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"framework-metadata-object-interface":{"type":"object","description":"Provides metadata about an attribute.","properties":{"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["attribute_code"]}}} diff --git a/src/swagger/schemas/2.2.10.schema.json b/src/swagger/schemas/2.2.10.schema.json deleted file mode 100644 index 09d313d4dca..00000000000 --- a/src/swagger/schemas/2.2.10.schema.json +++ /dev/null @@ -1,39760 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2.2.10", - "title": "Magento B2B" - }, - "host": "example.com", - "basePath": "/rest/default", - "schemes": [ - "https" - ], - "tags": [ - { - "name": "storeStoreRepositoryV1", - "description": "Store repository interface" - }, - { - "name": "storeGroupRepositoryV1", - "description": "Group repository interface" - }, - { - "name": "storeWebsiteRepositoryV1", - "description": "Website repository interface" - }, - { - "name": "storeStoreConfigManagerV1", - "description": "Store config manager interface" - }, - { - "name": "directoryCurrencyInformationAcquirerV1", - "description": "Currency information acquirer interface" - }, - { - "name": "directoryCountryInformationAcquirerV1", - "description": "Country information acquirer interface" - }, - { - "name": "eavAttributeSetRepositoryV1", - "description": "Interface AttributeSetRepositoryInterface" - }, - { - "name": "eavAttributeSetManagementV1", - "description": "Interface AttributeSetManagementInterface" - }, - { - "name": "customerGroupRepositoryV1", - "description": "Customer group CRUD interface" - }, - { - "name": "customerGroupManagementV1", - "description": "Interface for managing customer groups." - }, - { - "name": "customerCustomerGroupConfigV1", - "description": "Interface for system configuration operations for customer groups." - }, - { - "name": "customerCustomerMetadataV1", - "description": "Interface for retrieval information about customer attributes metadata." - }, - { - "name": "customerAddressMetadataV1", - "description": "Interface for retrieval information about customer address attributes metadata." - }, - { - "name": "customerCustomerRepositoryV1", - "description": "Customer CRUD interface." - }, - { - "name": "customerAccountManagementV1", - "description": "Interface for managing customers accounts." - }, - { - "name": "customerAddressRepositoryV1", - "description": "Customer address CRUD interface." - }, - { - "name": "backendModuleServiceV1", - "description": "Interface for module service." - }, - { - "name": "cmsPageRepositoryV1", - "description": "CMS page CRUD interface." - }, - { - "name": "cmsBlockRepositoryV1", - "description": "CMS block CRUD interface." - }, - { - "name": "catalogProductRepositoryV1", - "description": "" - }, - { - "name": "catalogProductAttributeTypesListV1", - "description": "" - }, - { - "name": "catalogProductAttributeRepositoryV1", - "description": "Interface RepositoryInterface must be implemented in new model" - }, - { - "name": "catalogCategoryAttributeRepositoryV1", - "description": "Interface RepositoryInterface must be implemented in new model" - }, - { - "name": "catalogCategoryAttributeOptionManagementV1", - "description": "Interface RepositoryInterface must be implemented in new model" - }, - { - "name": "catalogProductTypeListV1", - "description": "" - }, - { - "name": "catalogAttributeSetRepositoryV1", - "description": "" - }, - { - "name": "catalogAttributeSetManagementV1", - "description": "" - }, - { - "name": "catalogProductAttributeManagementV1", - "description": "" - }, - { - "name": "catalogProductAttributeGroupRepositoryV1", - "description": "" - }, - { - "name": "catalogProductAttributeOptionManagementV1", - "description": "" - }, - { - "name": "catalogProductMediaAttributeManagementV1", - "description": "" - }, - { - "name": "catalogProductAttributeMediaGalleryManagementV1", - "description": "" - }, - { - "name": "catalogProductTierPriceManagementV1", - "description": "" - }, - { - "name": "catalogTierPriceStorageV1", - "description": "Tier prices storage." - }, - { - "name": "catalogBasePriceStorageV1", - "description": "Base prices storage." - }, - { - "name": "catalogCostStorageV1", - "description": "Product cost storage." - }, - { - "name": "catalogSpecialPriceStorageV1", - "description": "Special price storage presents efficient price API and is used to retrieve, update or delete special prices." - }, - { - "name": "catalogCategoryRepositoryV1", - "description": "" - }, - { - "name": "catalogCategoryManagementV1", - "description": "" - }, - { - "name": "catalogCategoryListV1", - "description": "" - }, - { - "name": "catalogProductCustomOptionTypeListV1", - "description": "" - }, - { - "name": "catalogProductCustomOptionRepositoryV1", - "description": "" - }, - { - "name": "catalogProductLinkTypeListV1", - "description": "" - }, - { - "name": "catalogProductLinkManagementV1", - "description": "" - }, - { - "name": "catalogProductLinkRepositoryV1", - "description": "Interface Product links handling interface" - }, - { - "name": "catalogCategoryLinkManagementV1", - "description": "" - }, - { - "name": "catalogCategoryLinkRepositoryV1", - "description": "" - }, - { - "name": "catalogProductWebsiteLinkRepositoryV1", - "description": "Interface ProductWebsiteLinkRepositoryInterface" - }, - { - "name": "catalogProductRenderListV1", - "description": "Interface which provides product renders information for products" - }, - { - "name": "quoteCartRepositoryV1", - "description": "Interface CartRepositoryInterface" - }, - { - "name": "quoteCartManagementV1", - "description": "Interface CartManagementInterface" - }, - { - "name": "quoteGuestCartRepositoryV1", - "description": "Cart Repository interface for guest carts." - }, - { - "name": "quoteGuestCartManagementV1", - "description": "Cart Management interface for guest carts." - }, - { - "name": "quoteShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "quoteShipmentEstimationV1", - "description": "Interface ShipmentManagementInterface" - }, - { - "name": "quoteGuestShippingMethodManagementV1", - "description": "Shipping method management interface for guest carts." - }, - { - "name": "quoteGuestShipmentEstimationV1", - "description": "Interface GuestShipmentEstimationInterface" - }, - { - "name": "quoteCartItemRepositoryV1", - "description": "Interface CartItemRepositoryInterface" - }, - { - "name": "quoteGuestCartItemRepositoryV1", - "description": "Cart Item repository interface for guest carts." - }, - { - "name": "quotePaymentMethodManagementV1", - "description": "Interface PaymentMethodManagementInterface" - }, - { - "name": "quoteGuestPaymentMethodManagementV1", - "description": "Payment method management interface for guest carts." - }, - { - "name": "quoteBillingAddressManagementV1", - "description": "Interface BillingAddressManagementInterface" - }, - { - "name": "quoteGuestBillingAddressManagementV1", - "description": "Billing address management interface for guest carts." - }, - { - "name": "quoteCouponManagementV1", - "description": "Coupon management service interface." - }, - { - "name": "quoteGuestCouponManagementV1", - "description": "Coupon management interface for guest carts." - }, - { - "name": "quoteCartTotalRepositoryV1", - "description": "Interface CartTotalRepositoryInterface" - }, - { - "name": "quoteGuestCartTotalManagementV1", - "description": "Bundled API to collect totals for cart based on shipping/payment methods and additional data." - }, - { - "name": "quoteGuestCartTotalRepositoryV1", - "description": "Cart totals repository interface for guest carts." - }, - { - "name": "quoteCartTotalManagementV1", - "description": "Bundled API to collect totals for cart based on shipping/payment methods and additional data." - }, - { - "name": "bundleProductLinkManagementV1", - "description": "Interface for Management of ProductLink" - }, - { - "name": "bundleProductOptionRepositoryV1", - "description": "Interface ProductOptionRepositoryInterface" - }, - { - "name": "bundleProductOptionTypeListV1", - "description": "Interface ProductOptionTypeListInterface" - }, - { - "name": "bundleProductOptionManagementV1", - "description": "Option manager for bundle products" - }, - { - "name": "requisitionListRequisitionListRepositoryV1", - "description": "Interface RequisitionListRepositoryInterface" - }, - { - "name": "searchV1", - "description": "Search API for all requests" - }, - { - "name": "catalogInventoryStockRegistryV1", - "description": "Interface StockRegistryInterface" - }, - { - "name": "salesOrderRepositoryV1", - "description": "Order repository 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." - }, - { - "name": "salesOrderManagementV1", - "description": "Order management 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." - }, - { - "name": "salesOrderAddressRepositoryV1", - "description": "Order address repository 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." - }, - { - "name": "salesOrderItemRepositoryV1", - "description": "Order item repository 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." - }, - { - "name": "salesInvoiceRepositoryV1", - "description": "Invoice repository interface. An invoice is a record of the receipt of payment for an order." - }, - { - "name": "salesInvoiceManagementV1", - "description": "Invoice management interface. An invoice is a record of the receipt of payment for an order." - }, - { - "name": "salesInvoiceCommentRepositoryV1", - "description": "Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history." - }, - { - "name": "salesRefundInvoiceV1", - "description": "Interface RefundInvoiceInterface" - }, - { - "name": "salesCreditmemoManagementV1", - "description": "Credit memo add 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." - }, - { - "name": "salesCreditmemoRepositoryV1", - "description": "Credit memo repository 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." - }, - { - "name": "salesCreditmemoCommentRepositoryV1", - "description": "Credit memo comment repository 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." - }, - { - "name": "salesRefundOrderV1", - "description": "Interface RefundOrderInterface" - }, - { - "name": "salesShipmentRepositoryV1", - "description": "Shipment repository 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." - }, - { - "name": "salesShipmentManagementV1", - "description": "Shipment management 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." - }, - { - "name": "salesShipmentCommentRepositoryV1", - "description": "Shipment comment repository 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." - }, - { - "name": "salesShipmentTrackRepositoryV1", - "description": "Shipment track repository 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." - }, - { - "name": "salesShipOrderV1", - "description": "Class ShipOrderInterface" - }, - { - "name": "salesTransactionRepositoryV1", - "description": "Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on." - }, - { - "name": "salesInvoiceOrderV1", - "description": "Class InvoiceOrderInterface" - }, - { - "name": "checkoutGuestShippingInformationManagementV1", - "description": "Interface for managing guest shipping address information" - }, - { - "name": "checkoutShippingInformationManagementV1", - "description": "Interface for managing customer shipping address information" - }, - { - "name": "checkoutTotalsInformationManagementV1", - "description": "Interface for quote totals calculation" - }, - { - "name": "checkoutGuestTotalsInformationManagementV1", - "description": "Interface for guest quote totals calculation" - }, - { - "name": "checkoutGuestPaymentInformationManagementV1", - "description": "Interface for managing guest payment information" - }, - { - "name": "checkoutPaymentInformationManagementV1", - "description": "Interface for managing quote payment information" - }, - { - "name": "salesRuleRuleRepositoryV1", - "description": "Sales rule CRUD interface" - }, - { - "name": "salesRuleCouponRepositoryV1", - "description": "Coupon CRUD interface" - }, - { - "name": "salesRuleCouponManagementV1", - "description": "Coupon management interface" - }, - { - "name": "configurableProductLinkManagementV1", - "description": "Manage children products of configurable product" - }, - { - "name": "configurableProductConfigurableProductManagementV1", - "description": "Interface ConfigurableProductManagementInterface" - }, - { - "name": "configurableProductOptionRepositoryV1", - "description": "Manage options of configurable product" - }, - { - "name": "downloadableLinkRepositoryV1", - "description": "Interface LinkRepositoryInterface" - }, - { - "name": "downloadableSampleRepositoryV1", - "description": "Interface SampleRepositoryInterface" - }, - { - "name": "checkoutAgreementsCheckoutAgreementsRepositoryV1", - "description": "Interface CheckoutAgreementsRepositoryInterface" - }, - { - "name": "taxTaxRateRepositoryV1", - "description": "Tax rate CRUD interface." - }, - { - "name": "taxTaxRuleRepositoryV1", - "description": "Tax rule CRUD interface." - }, - { - "name": "taxTaxClassRepositoryV1", - "description": "Tax class CRUD interface." - }, - { - "name": "companyCompanyRepositoryV1", - "description": "A repository interface for company entity that provides basic CRUD operations." - }, - { - "name": "companyTeamRepositoryV1", - "description": "Interface for basic CRUD operations for team entity." - }, - { - "name": "companyCompanyHierarchyV1", - "description": "Interface for working with company hierarchy." - }, - { - "name": "companyRoleRepositoryV1", - "description": "A repository interface for role entity that provides basic CRUD operations." - }, - { - "name": "companyAclV1", - "description": "Access control list interface." - }, - { - "name": "integrationAdminTokenServiceV1", - "description": "Interface providing token generation for Admins" - }, - { - "name": "integrationCustomerTokenServiceV1", - "description": "Interface providing token generation for Customers" - }, - { - "name": "analyticsLinkProviderV1", - "description": "Provides link to file with collected report data." - }, - { - "name": "customerBalanceBalanceManagementFromQuoteV1", - "description": "Customer balance(store credit) operations." - }, - { - "name": "negotiableQuoteNegotiableQuoteManagementV1", - "description": "Interface for managing quotes." - }, - { - "name": "negotiableQuoteNegotiableQuotePriceManagementV1", - "description": "Interface for updating quote prices in case price changes occur in system." - }, - { - "name": "negotiableQuoteAttachmentContentManagementV1", - "description": "Interface for retrieving the list of negotiable quotes attachments." - }, - { - "name": "negotiableQuoteCommentLocatorV1", - "description": "Interface for load quote comments with attachment." - }, - { - "name": "negotiableQuoteNegotiableQuoteShippingManagementV1", - "description": "Interface for add and update negotiable quote shipping method." - }, - { - "name": "negotiableQuotePaymentInformationManagementV1", - "description": "Interface for managing quote payment information" - }, - { - "name": "negotiableQuoteShippingInformationManagementV1", - "description": "Interface for managing customer shipping address information" - }, - { - "name": "negotiableQuoteShipmentEstimationV1", - "description": "Interface ShipmentManagementInterface" - }, - { - "name": "negotiableQuoteShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "negotiableQuoteNegotiableCartRepositoryV1", - "description": "Interface is intended to be used in webapi only. For other cases CartRepositoryInterface should be used." - }, - { - "name": "negotiableQuoteBillingAddressManagementV1", - "description": "Interface BillingAddressManagementInterface" - }, - { - "name": "negotiableQuoteCartTotalRepositoryV1", - "description": "Interface CartTotalRepositoryInterface" - }, - { - "name": "negotiableQuoteCouponManagementV1", - "description": "Coupon management service interface." - }, - { - "name": "negotiableQuoteGiftCardAccountManagementV1", - "description": "Interface GiftCardAccountManagementInterface" - }, - { - "name": "giftCardAccountGiftCardAccountManagementV1", - "description": "Interface GiftCardAccountManagementInterface" - }, - { - "name": "giftCardAccountGuestGiftCardAccountManagementV1", - "description": "Interface GuestGiftCardAccountManagementInterface" - }, - { - "name": "sharedCatalogSharedCatalogRepositoryV1", - "description": "" - }, - { - "name": "sharedCatalogCompanyManagementV1", - "description": "Shared catalog companies actions." - }, - { - "name": "sharedCatalogProductManagementV1", - "description": "Shared catalog products actions." - }, - { - "name": "sharedCatalogCategoryManagementV1", - "description": "Shared catalog products actions." - }, - { - "name": "giftMessageCartRepositoryV1", - "description": "Interface CartRepositoryInterface" - }, - { - "name": "giftMessageItemRepositoryV1", - "description": "Interface ItemRepositoryInterface" - }, - { - "name": "giftMessageGuestCartRepositoryV1", - "description": "Interface GuestCartRepositoryInterface" - }, - { - "name": "giftMessageGuestItemRepositoryV1", - "description": "Interface GuestItemRepositoryInterface" - }, - { - "name": "giftRegistryShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "giftRegistryGuestCartShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "giftWrappingWrappingRepositoryV1", - "description": "Interface WrappingRepositoryInterface" - }, - { - "name": "rewardRewardManagementV1", - "description": "Interface RewardManagementInterface" - }, - { - "name": "rmaTrackManagementV1", - "description": "Interface TrackManagementInterface" - }, - { - "name": "rmaRmaRepositoryV1", - "description": "Interface RmaRepositoryInterface" - }, - { - "name": "rmaCommentManagementV1", - "description": "Interface CommentRepositoryInterface" - }, - { - "name": "rmaRmaManagementV1", - "description": "Interface RmaManagementInterface" - }, - { - "name": "rmaRmaAttributesManagementV1", - "description": "Interface RmaAttributesManagementInterface" - }, - { - "name": "companyCreditCreditLimitRepositoryV1", - "description": "Interface for credit limit repository for CRUD operations." - }, - { - "name": "companyCreditCreditLimitManagementV1", - "description": "Credit Limit management interface." - }, - { - "name": "companyCreditCreditBalanceManagementV1", - "description": "Interface for management decrease and increase credit balance operations." - }, - { - "name": "companyCreditCreditHistoryManagementV1", - "description": "Update credit history log and retrieve history which match a specified criteria." - }, - { - "name": "asynchronousOperationsBulkStatusV1", - "description": "Interface BulkStatusInterface Bulk summary data with list of operations items short data." - }, - { - "name": "worldpayGuestPaymentInformationManagementProxyV1", - "description": "Interface GuestPaymentInformationManagementProxyInterface" - }, - { - "name": "amazonPaymentAddressManagementV1", - "description": "" - }, - { - "name": "amazonPaymentOrderInformationManagementV1", - "description": "" - }, - { - "name": "temandoShippingQuoteCartDeliveryOptionManagementV1", - "description": "CartDeliveryOptionManagementInterface" - }, - { - "name": "temandoShippingQuoteGuestCartDeliveryOptionManagementV1", - "description": "GuestCartDeliveryOptionManagementInterface" - }, - { - "name": "temandoShippingRmaRmaShipmentManagementV1", - "description": "Manage RMA Shipments" - }, - { - "name": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1", - "description": "Process Collection Point Search (Guest Checkout)" - }, - { - "name": "temandoShippingCollectionPointCartCollectionPointManagementV1", - "description": "Process Collection Point Search" - }, - { - "name": "temandoShippingQuoteGuestCartCheckoutFieldManagementV1", - "description": "Interface GuestCartCheckoutFieldManagementInterface Persist value-added services as selected during guest checkout." - }, - { - "name": "temandoShippingQuoteCartCheckoutFieldManagementV1", - "description": "Interface CartCheckoutFieldManagementInterface Persist value-added services as selected during logged-in checkout." - } - ], - "paths": { - "/V1/store/storeViews": { - "get": { - "tags": [ - "storeStoreRepositoryV1" - ], - "description": "Retrieve list of all stores", - "operationId": "storeStoreRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-store-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/store/storeGroups": { - "get": { - "tags": [ - "storeGroupRepositoryV1" - ], - "description": "Retrieve list of all groups", - "operationId": "storeGroupRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-group-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/store/websites": { - "get": { - "tags": [ - "storeWebsiteRepositoryV1" - ], - "description": "Retrieve list of all websites", - "operationId": "storeWebsiteRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-website-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/store/storeConfigs": { - "get": { - "tags": [ - "storeStoreConfigManagerV1" - ], - "description": "", - "operationId": "storeStoreConfigManagerV1GetStoreConfigsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "storeCodes", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-store-config-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/directory/currency": { - "get": { - "tags": [ - "directoryCurrencyInformationAcquirerV1" - ], - "description": "Get currency information for the store.", - "operationId": "directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/directory-data-currency-information-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/directory/countries": { - "get": { - "tags": [ - "directoryCountryInformationAcquirerV1" - ], - "description": "Get all countries and regions information for the store.", - "operationId": "directoryCountryInformationAcquirerV1GetCountriesInfoGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/directory-data-country-information-interface" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/directory/countries/{countryId}": { - "get": { - "tags": [ - "directoryCountryInformationAcquirerV1" - ], - "description": "Get country and region information for the store.", - "operationId": "directoryCountryInformationAcquirerV1GetCountryInfoGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "countryId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/directory-data-country-information-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/eav/attribute-sets/list": { - "get": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "description": "Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "eavAttributeSetRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/eav/attribute-sets/{attributeSetId}": { - "get": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "description": "Retrieve attribute set information based on given ID", - "operationId": "eavAttributeSetRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/eav/attribute-sets": { - "post": { - "tags": [ - "eavAttributeSetManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/{id}": { - "get": { - "tags": [ - "customerGroupRepositoryV1" - ], - "description": "Get customer group by group ID.", - "operationId": "customerGroupRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "customerGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "customerGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/search": { - "get": { - "tags": [ - "customerGroupRepositoryV1" - ], - "description": "Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "customerGroupRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups": { - "post": { - "tags": [ - "customerGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/default/{storeId}": { - "get": { - "tags": [ - "customerGroupManagementV1" - ], - "description": "Get default customer group.", - "operationId": "customerGroupManagementV1GetDefaultGroupGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "storeId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/default": { - "get": { - "tags": [ - "customerGroupManagementV1" - ], - "description": "Get default customer group.", - "operationId": "customerGroupManagementV1GetDefaultGroupGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/{id}/permissions": { - "get": { - "tags": [ - "customerGroupManagementV1" - ], - "description": "Check if customer group can be deleted.", - "operationId": "customerGroupManagementV1IsReadonlyGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/default/{id}": { - "put": { - "tags": [ - "customerCustomerGroupConfigV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer/attribute/{attributeCode}": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Retrieve attribute metadata.", - "operationId": "customerCustomerMetadataV1GetAttributeMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer/form/{formCode}": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Retrieve all attributes filtered by form code", - "operationId": "customerCustomerMetadataV1GetAttributesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "formCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Get all attribute metadata.", - "operationId": "customerCustomerMetadataV1GetAllAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer/custom": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Get custom attributes metadata for the given data interface.", - "operationId": "customerCustomerMetadataV1GetCustomAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "dataInterfaceName", - "in": "query", - "type": "string", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress/attribute/{attributeCode}": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Retrieve attribute metadata.", - "operationId": "customerAddressMetadataV1GetAttributeMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress/form/{formCode}": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Retrieve all attributes filtered by form code", - "operationId": "customerAddressMetadataV1GetAttributesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "formCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Get all attribute metadata.", - "operationId": "customerAddressMetadataV1GetAllAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress/custom": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Get custom attributes metadata for the given data interface.", - "operationId": "customerAddressMetadataV1GetCustomAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "dataInterfaceName", - "in": "query", - "type": "string", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}": { - "get": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Get customer by Customer ID.", - "operationId": "customerCustomerRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me": { - "put": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Get customer by Customer ID.", - "operationId": "customerCustomerRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/search": { - "get": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "customerCustomerRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/activate": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{email}/activate": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/password": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Check if password reset token is valid.", - "operationId": "customerAccountManagementV1ValidateResetPasswordLinkTokenGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true, - "description": "If 0 is given then a customer will be matched by the RP token." - }, - { - "name": "resetPasswordLinkToken", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "True if the token is valid" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/password": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/resetPassword": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/confirm": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Gets the account confirmation status.", - "operationId": "customerAccountManagementV1GetConfirmationStatusGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/confirm": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/validate": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-validation-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/permissions/readonly": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Check if customer can be deleted.", - "operationId": "customerAccountManagementV1IsReadonlyGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/isEmailAvailable": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/billingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default billing address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultBillingAddressGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/billingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default billing address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultBillingAddressGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/shippingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default shipping address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultShippingAddressGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/shippingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default shipping address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultShippingAddressGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/addresses/{addressId}": { - "get": { - "tags": [ - "customerAddressRepositoryV1" - ], - "description": "Retrieve customer address.", - "operationId": "customerAddressRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "addressId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/addresses/{addressId}": { - "delete": { - "tags": [ - "customerAddressRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/modules": { - "get": { - "tags": [ - "backendModuleServiceV1" - ], - "description": "Returns an array of enabled modules", - "operationId": "backendModuleServiceV1GetModulesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage/{pageId}": { - "get": { - "tags": [ - "cmsPageRepositoryV1" - ], - "description": "Retrieve page.", - "operationId": "cmsPageRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "pageId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "cmsPageRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage/search": { - "get": { - "tags": [ - "cmsPageRepositoryV1" - ], - "description": "Retrieve pages matching the specified criteria.", - "operationId": "cmsPageRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage": { - "post": { - "tags": [ - "cmsPageRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage/{id}": { - "put": { - "tags": [ - "cmsPageRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock/{blockId}": { - "get": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "description": "Retrieve block.", - "operationId": "cmsBlockRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "blockId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock/search": { - "get": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "description": "Retrieve blocks matching the specified criteria.", - "operationId": "cmsBlockRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock": { - "post": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock/{id}": { - "put": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products": { - "post": { - "tags": [ - "catalogProductRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogProductRepositoryV1" - ], - "description": "Get product list", - "operationId": "catalogProductRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}": { - "put": { - "tags": [ - "catalogProductRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductRepositoryV1" - ], - "description": "", - "operationId": "catalogProductRepositoryV1DeleteByIdDelete", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "Will returned True if deleted" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogProductRepositoryV1" - ], - "description": "Get info about product by product SKU", - "operationId": "catalogProductRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "editMode", - "in": "query", - "type": "boolean", - "required": false - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - }, - { - "name": "forceReload", - "in": "query", - "type": "boolean", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/types": { - "get": { - "tags": [ - "catalogProductAttributeTypesListV1" - ], - "description": "Retrieve list of product attribute types", - "operationId": "catalogProductAttributeTypesListV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/{attributeCode}": { - "get": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "description": "Retrieve specific attribute", - "operationId": "catalogProductAttributeRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes": { - "get": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "description": "Retrieve all attributes for entity type", - "operationId": "catalogProductAttributeRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/attributes/{attributeCode}": { - "get": { - "tags": [ - "catalogCategoryAttributeRepositoryV1" - ], - "description": "Retrieve specific attribute", - "operationId": "catalogCategoryAttributeRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-attribute-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/attributes": { - "get": { - "tags": [ - "catalogCategoryAttributeRepositoryV1" - ], - "description": "Retrieve all attributes for entity type", - "operationId": "catalogCategoryAttributeRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-attribute-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/attributes/{attributeCode}/options": { - "get": { - "tags": [ - "catalogCategoryAttributeOptionManagementV1" - ], - "description": "Retrieve list of attribute options", - "operationId": "catalogCategoryAttributeOptionManagementV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/eav-data-attribute-option-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/types": { - "get": { - "tags": [ - "catalogProductTypeListV1" - ], - "description": "Retrieve available product types", - "operationId": "catalogProductTypeListV1GetProductTypesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/sets/list": { - "get": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "description": "Retrieve list of Attribute Sets", - "operationId": "catalogAttributeSetRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}": { - "get": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "description": "Retrieve attribute set information based on given ID", - "operationId": "catalogAttributeSetRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets": { - "post": { - "tags": [ - "catalogAttributeSetManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}/attributes": { - "get": { - "tags": [ - "catalogProductAttributeManagementV1" - ], - "description": "Retrieve related attributes based on given attribute set ID", - "operationId": "catalogProductAttributeManagementV1GetAttributesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/attributes": { - "post": { - "tags": [ - "catalogProductAttributeManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}": { - "delete": { - "tags": [ - "catalogProductAttributeManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/groups/list": { - "get": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "description": "Retrieve list of attribute groups", - "operationId": "catalogProductAttributeGroupRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-group-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/groups": { - "post": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}/groups": { - "put": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/groups/{groupId}": { - "delete": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/{attributeCode}/options": { - "get": { - "tags": [ - "catalogProductAttributeOptionManagementV1" - ], - "description": "Retrieve list of attribute options", - "operationId": "catalogProductAttributeOptionManagementV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/eav-data-attribute-option-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "catalogProductAttributeOptionManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/{attributeCode}/options/{optionId}": { - "delete": { - "tags": [ - "catalogProductAttributeOptionManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/media/types/{attributeSetName}": { - "get": { - "tags": [ - "catalogProductMediaAttributeManagementV1" - ], - "description": "Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.", - "operationId": "catalogProductMediaAttributeManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeSetName", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "list of media attributes", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/media/{entryId}": { - "get": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "description": "Return information about gallery entry", - "operationId": "catalogProductAttributeMediaGalleryManagementV1GetGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/media": { - "post": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "gallery entry ID" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "description": "Retrieve the list of gallery entries associated with given product", - "operationId": "catalogProductAttributeMediaGalleryManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers": { - "get": { - "tags": [ - "catalogProductTierPriceManagementV1" - ], - "description": "Get tier price of product", - "operationId": "catalogProductTierPriceManagementV1GetListGet", - "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'" - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-tier-price-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}": { - "post": { - "tags": [ - "catalogProductTierPriceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}": { - "delete": { - "tags": [ - "catalogProductTierPriceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/tier-prices-information": { - "post": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-tier-price-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/tier-prices": { - "post": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/tier-prices-delete": { - "post": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/base-prices-information": { - "post": { - "tags": [ - "catalogBasePriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-base-price-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/base-prices": { - "post": { - "tags": [ - "catalogBasePriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/cost-information": { - "post": { - "tags": [ - "catalogCostStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-cost-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/cost": { - "post": { - "tags": [ - "catalogCostStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/cost-delete": { - "post": { - "tags": [ - "catalogCostStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "Will return True if deleted." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/special-price-information": { - "post": { - "tags": [ - "catalogSpecialPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-special-price-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/special-price": { - "post": { - "tags": [ - "catalogSpecialPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/special-price-delete": { - "post": { - "tags": [ - "catalogSpecialPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}": { - "delete": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "Will returned True if deleted" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "description": "Get info about category by category id", - "operationId": "catalogCategoryRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "categoryId", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories": { - "post": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogCategoryManagementV1" - ], - "description": "Retrieve list of categories", - "operationId": "catalogCategoryManagementV1GetTreeGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "rootCategoryId", - "in": "query", - "type": "integer", - "required": false - }, - { - "name": "depth", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-tree-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{id}": { - "put": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}/move": { - "put": { - "tags": [ - "catalogCategoryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/list": { - "get": { - "tags": [ - "catalogCategoryListV1" - ], - "description": "Get category list", - "operationId": "catalogCategoryListV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/options/types": { - "get": { - "tags": [ - "catalogProductCustomOptionTypeListV1" - ], - "description": "Get custom option types", - "operationId": "catalogProductCustomOptionTypeListV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-custom-option-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/options": { - "get": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "description": "Get the list of custom options for a specific product", - "operationId": "catalogProductCustomOptionRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/options/{optionId}": { - "get": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "description": "Get custom option for a specific product", - "operationId": "catalogProductCustomOptionRepositoryV1GetGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/options": { - "post": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/options/{optionId}": { - "put": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/links/types": { - "get": { - "tags": [ - "catalogProductLinkTypeListV1" - ], - "description": "Retrieve information about available product link types", - "operationId": "catalogProductLinkTypeListV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-link-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/links/{type}/attributes": { - "get": { - "tags": [ - "catalogProductLinkTypeListV1" - ], - "description": "Provide a list of the product link type attributes", - "operationId": "catalogProductLinkTypeListV1GetItemAttributesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "type", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-link-attribute-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/links/{type}": { - "get": { - "tags": [ - "catalogProductLinkManagementV1" - ], - "description": "Provide the list of links for a specific product", - "operationId": "catalogProductLinkManagementV1GetLinkedItemsByTypeGet", - "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 - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-link-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/links": { - "post": { - "tags": [ - "catalogProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/links/{type}/{linkedProductSku}": { - "delete": { - "tags": [ - "catalogProductLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}/products": { - "get": { - "tags": [ - "catalogCategoryLinkManagementV1" - ], - "description": "Get products assigned to category", - "operationId": "catalogCategoryLinkManagementV1GetAssignedProductsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "categoryId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-category-product-link-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "catalogCategoryLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if assigned" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogCategoryLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if assigned" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}/products/{sku}": { - "delete": { - "tags": [ - "catalogCategoryLinkRepositoryV1" - ], - "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": "string", - "required": true - }, - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if products successfully deleted" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/websites": { - "post": { - "tags": [ - "catalogProductWebsiteLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if website successfully assigned to product" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductWebsiteLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if website successfully assigned to product" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/websites/{websiteId}": { - "delete": { - "tags": [ - "catalogProductWebsiteLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if website successfully unassigned from product" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products-render-info": { - "get": { - "tags": [ - "catalogProductRenderListV1" - ], - "description": "Collect and retrieve the list of product render info This info contains raw prices and formated prices, product name, stock status, store_id, etc", - "operationId": "catalogProductRenderListV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": true - }, - { - "name": "currencyCode", - "in": "query", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-render-search-results-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}": { - "get": { - "tags": [ - "quoteCartRepositoryV1" - ], - "description": "Enables an administrative user to return information for a specified cart.", - "operationId": "quoteCartRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quoteCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/search": { - "get": { - "tags": [ - "quoteCartRepositoryV1" - ], - "description": "Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quoteCartRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine": { - "put": { - "tags": [ - "quoteCartRepositoryV1" - ], - "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" - } - } - } - }, - "post": { - "tags": [ - "quoteCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "new cart ID if customer did not have a cart or ID of the existing cart otherwise." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "quoteCartManagementV1" - ], - "description": "Returns information for the cart for a specified customer.", - "operationId": "quoteCartManagementV1GetCartForCustomerGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/": { - "post": { - "tags": [ - "quoteCartManagementV1" - ], - "description": "Creates an empty cart and quote for a guest.", - "operationId": "quoteCartManagementV1CreateEmptyCartPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Cart ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/carts": { - "post": { - "tags": [ - "quoteCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "new cart ID if customer did not have a cart or ID of the existing cart otherwise." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/order": { - "put": { - "tags": [ - "quoteCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/order": { - "put": { - "tags": [ - "quoteCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}": { - "get": { - "tags": [ - "quoteGuestCartRepositoryV1" - ], - "description": "Enable a guest user to return information for a specified cart.", - "operationId": "quoteGuestCartRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quoteGuestCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts": { - "post": { - "tags": [ - "quoteGuestCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Cart ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/order": { - "put": { - "tags": [ - "quoteGuestCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/shipping-methods": { - "get": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "description": "Lists applicable shipping methods for a specified quote.", - "operationId": "quoteShippingMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/estimate-shipping-methods-by-address-id": { - "post": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/shipping-methods": { - "get": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "description": "Lists applicable shipping methods for a specified quote.", - "operationId": "quoteShippingMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/estimate-shipping-methods-by-address-id": { - "post": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "quoteShipmentEstimationV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/estimate-shipping-methods": { - "post": { - "tags": [ - "quoteShipmentEstimationV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/shipping-methods": { - "get": { - "tags": [ - "quoteGuestShippingMethodManagementV1" - ], - "description": "List applicable shipping methods for a specified quote.", - "operationId": "quoteGuestShippingMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "quoteGuestShipmentEstimationV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/items": { - "get": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Lists items that are assigned to a specified cart.", - "operationId": "quoteCartItemRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of items.", - "items": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{quoteId}/items": { - "post": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/items/{itemId}": { - "put": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/items": { - "get": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Lists items that are assigned to a specified cart.", - "operationId": "quoteCartItemRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of items.", - "items": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/items/{itemId}": { - "put": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/items": { - "get": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "description": "List items that are assigned to a specified cart.", - "operationId": "quoteGuestCartItemRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of items.", - "items": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/items/{itemId}": { - "put": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/selected-payment-method": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Returns the payment method for a specified shopping cart.", - "operationId": "quotePaymentMethodManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-payment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "redirect url or error message." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/payment-methods": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quotePaymentMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of payment methods.", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/selected-payment-method": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Returns the payment method for a specified shopping cart.", - "operationId": "quotePaymentMethodManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-payment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "redirect url or error message." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/payment-methods": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quotePaymentMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of payment methods.", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/selected-payment-method": { - "get": { - "tags": [ - "quoteGuestPaymentMethodManagementV1" - ], - "description": "Return the payment method for a specified shopping cart.", - "operationId": "quoteGuestPaymentMethodManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-payment-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quoteGuestPaymentMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Payment method ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/payment-methods": { - "get": { - "tags": [ - "quoteGuestPaymentMethodManagementV1" - ], - "description": "List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quoteGuestPaymentMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of payment methods.", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/billing-address": { - "get": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "description": "Returns the billing address for a specified quote.", - "operationId": "quoteBillingAddressManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/billing-address": { - "get": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "description": "Returns the billing address for a specified quote.", - "operationId": "quoteBillingAddressManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/billing-address": { - "get": { - "tags": [ - "quoteGuestBillingAddressManagementV1" - ], - "description": "Return the billing address for a specified quote.", - "operationId": "quoteGuestBillingAddressManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteGuestBillingAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/coupons": { - "get": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Returns information for a coupon in a specified cart.", - "operationId": "quoteCouponManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "The coupon code data." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/coupons/{couponCode}": { - "put": { - "tags": [ - "quoteCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/coupons": { - "get": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Returns information for a coupon in a specified cart.", - "operationId": "quoteCouponManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "The coupon code data." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Deletes a coupon from a specified cart.", - "operationId": "quoteCouponManagementV1RemoveDelete", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/coupons/{couponCode}": { - "put": { - "tags": [ - "quoteCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/coupons": { - "get": { - "tags": [ - "quoteGuestCouponManagementV1" - ], - "description": "Return information for a coupon in a specified cart.", - "operationId": "quoteGuestCouponManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "The coupon code data." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteGuestCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/coupons/{couponCode}": { - "put": { - "tags": [ - "quoteGuestCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/totals": { - "get": { - "tags": [ - "quoteCartTotalRepositoryV1" - ], - "description": "Returns quote totals data for a specified cart.", - "operationId": "quoteCartTotalRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/totals": { - "get": { - "tags": [ - "quoteCartTotalRepositoryV1" - ], - "description": "Returns quote totals data for a specified cart.", - "operationId": "quoteCartTotalRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collect-totals": { - "put": { - "tags": [ - "quoteGuestCartTotalManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/totals": { - "get": { - "tags": [ - "quoteGuestCartTotalRepositoryV1" - ], - "description": "Return quote totals data for a specified cart.", - "operationId": "quoteGuestCartTotalRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collect-totals": { - "put": { - "tags": [ - "quoteCartTotalManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/links/{optionId}": { - "post": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/links/{id}": { - "put": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{productSku}/children": { - "get": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "description": "Get all children for Bundle product", - "operationId": "bundleProductLinkManagementV1GetChildrenGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "productSku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "optionId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/bundle-data-link-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}": { - "delete": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/options/all": { - "get": { - "tags": [ - "bundleProductOptionRepositoryV1" - ], - "description": "Get all options for bundle product", - "operationId": "bundleProductOptionRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/bundle-data-option-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/options/{optionId}": { - "get": { - "tags": [ - "bundleProductOptionRepositoryV1" - ], - "description": "Get option for bundle product", - "operationId": "bundleProductOptionRepositoryV1GetGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/bundle-data-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "bundleProductOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/options/types": { - "get": { - "tags": [ - "bundleProductOptionTypeListV1" - ], - "description": "Get all types for options for bundle products", - "operationId": "bundleProductOptionTypeListV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/bundle-data-option-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/options/add": { - "post": { - "tags": [ - "bundleProductOptionManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/options/{optionId}": { - "put": { - "tags": [ - "bundleProductOptionManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/requisition_lists": { - "post": { - "tags": [ - "requisitionListRequisitionListRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/requisition-list-data-requisition-list-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/search": { - "get": { - "tags": [ - "searchV1" - ], - "description": "Make Full Text Search and return found Documents", - "operationId": "searchV1SearchGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[requestName]", - "in": "query", - "type": "string" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/framework-search-search-result-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/stockItems/{productSku}": { - "get": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "description": "", - "operationId": "catalogInventoryStockRegistryV1GetStockItemBySkuGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "productSku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "scopeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{productSku}/stockItems/{itemId}": { - "put": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/stockItems/lowStock/": { - "get": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "description": "Retrieves a list of SKU's with low inventory qty", - "operationId": "catalogInventoryStockRegistryV1GetLowStockItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "scopeId", - "in": "query", - "type": "integer", - "required": true - }, - { - "name": "qty", - "in": "query", - "type": "number", - "required": true - }, - { - "name": "currentPage", - "in": "query", - "type": "integer", - "required": false - }, - { - "name": "pageSize", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-collection-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/stockStatuses/{productSku}": { - "get": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "description": "", - "operationId": "catalogInventoryStockRegistryV1GetStockStatusBySkuGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "productSku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "scopeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-inventory-data-stock-status-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}": { - "get": { - "tags": [ - "salesOrderRepositoryV1" - ], - "description": "Loads a specified order.", - "operationId": "salesOrderRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders": { - "get": { - "tags": [ - "salesOrderRepositoryV1" - ], - "description": "Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesOrderRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/create": { - "put": { - "tags": [ - "salesOrderRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/": { - "post": { - "tags": [ - "salesOrderRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/statuses": { - "get": { - "tags": [ - "salesOrderManagementV1" - ], - "description": "Gets the status for a specified order.", - "operationId": "salesOrderManagementV1GetStatusGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Order status." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/cancel": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/emails": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/hold": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/unhold": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/comments": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "salesOrderManagementV1" - ], - "description": "Lists comments for a specified order.", - "operationId": "salesOrderManagementV1GetCommentsListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-status-history-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{parent_id}": { - "put": { - "tags": [ - "salesOrderAddressRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/items/{id}": { - "get": { - "tags": [ - "salesOrderItemRepositoryV1" - ], - "description": "Loads a specified order item.", - "operationId": "salesOrderItemRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/items": { - "get": { - "tags": [ - "salesOrderItemRepositoryV1" - ], - "description": "Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesOrderItemRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-item-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}": { - "get": { - "tags": [ - "salesInvoiceRepositoryV1" - ], - "description": "Loads a specified invoice.", - "operationId": "salesInvoiceRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The invoice ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices": { - "get": { - "tags": [ - "salesInvoiceRepositoryV1" - ], - "description": "Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesInvoiceRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/": { - "post": { - "tags": [ - "salesInvoiceRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/comments": { - "get": { - "tags": [ - "salesInvoiceManagementV1" - ], - "description": "Lists comments for a specified invoice.", - "operationId": "salesInvoiceManagementV1GetCommentsListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The invoice ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/emails": { - "post": { - "tags": [ - "salesInvoiceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/void": { - "post": { - "tags": [ - "salesInvoiceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/capture": { - "post": { - "tags": [ - "salesInvoiceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/comments": { - "post": { - "tags": [ - "salesInvoiceCommentRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-comment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoice/{invoiceId}/refund": { - "post": { - "tags": [ - "salesRefundInvoiceV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/{id}/comments": { - "get": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "description": "Lists comments for a specified credit memo.", - "operationId": "salesCreditmemoManagementV1GetCommentsListGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "salesCreditmemoCommentRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-comment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/{id}": { - "put": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "salesCreditmemoRepositoryV1" - ], - "description": "Loads a specified credit memo.", - "operationId": "salesCreditmemoRepositoryV1GetGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/{id}/emails": { - "post": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/refund": { - "post": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemos": { - "get": { - "tags": [ - "salesCreditmemoRepositoryV1" - ], - "description": "Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesCreditmemoRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo": { - "post": { - "tags": [ - "salesCreditmemoRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/order/{orderId}/refund": { - "post": { - "tags": [ - "salesRefundOrderV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}": { - "get": { - "tags": [ - "salesShipmentRepositoryV1" - ], - "description": "Loads a specified shipment.", - "operationId": "salesShipmentRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The shipment ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipments": { - "get": { - "tags": [ - "salesShipmentRepositoryV1" - ], - "description": "Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesShipmentRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/": { - "post": { - "tags": [ - "salesShipmentRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}/comments": { - "get": { - "tags": [ - "salesShipmentManagementV1" - ], - "description": "Lists comments for a specified shipment.", - "operationId": "salesShipmentManagementV1GetCommentsListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The shipment ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "salesShipmentCommentRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-comment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}/emails": { - "post": { - "tags": [ - "salesShipmentManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}/label": { - "get": { - "tags": [ - "salesShipmentManagementV1" - ], - "description": "Gets a specified shipment label.", - "operationId": "salesShipmentManagementV1GetLabelGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The shipment label ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Shipment label." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/track": { - "post": { - "tags": [ - "salesShipmentTrackRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-track-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/track/{id}": { - "delete": { - "tags": [ - "salesShipmentTrackRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/order/{orderId}/ship": { - "post": { - "tags": [ - "salesShipOrderV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Id of created Shipment." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/transactions/{id}": { - "get": { - "tags": [ - "salesTransactionRepositoryV1" - ], - "description": "Loads a specified transaction.", - "operationId": "salesTransactionRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The transaction ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-transaction-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/transactions": { - "get": { - "tags": [ - "salesTransactionRepositoryV1" - ], - "description": "Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesTransactionRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-transaction-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/order/{orderId}/invoice": { - "post": { - "tags": [ - "salesInvoiceOrderV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/shipping-information": { - "post": { - "tags": [ - "checkoutGuestShippingInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/shipping-information": { - "post": { - "tags": [ - "checkoutShippingInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/shipping-information": { - "post": { - "tags": [ - "checkoutShippingInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/totals-information": { - "post": { - "tags": [ - "checkoutTotalsInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/totals-information": { - "post": { - "tags": [ - "checkoutTotalsInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/totals-information": { - "post": { - "tags": [ - "checkoutGuestTotalsInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/payment-information": { - "post": { - "tags": [ - "checkoutGuestPaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "checkoutGuestPaymentInformationManagementV1" - ], - "description": "Get payment information", - "operationId": "checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/set-payment-information": { - "post": { - "tags": [ - "checkoutGuestPaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/payment-information": { - "post": { - "tags": [ - "checkoutPaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "checkoutPaymentInformationManagementV1" - ], - "description": "Get payment information", - "operationId": "checkoutPaymentInformationManagementV1GetPaymentInformationGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/set-payment-information": { - "post": { - "tags": [ - "checkoutPaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/salesRules/{ruleId}": { - "get": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "description": "Get rule by ID.", - "operationId": "salesRuleRuleRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "ruleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/salesRules/search": { - "get": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "description": "Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesRuleRuleRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/salesRules": { - "post": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/{couponId}": { - "get": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "description": "Get coupon by coupon id.", - "operationId": "salesRuleCouponRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "couponId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/search": { - "get": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "description": "Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesRuleCouponRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons": { - "post": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/generate": { - "post": { - "tags": [ - "salesRuleCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/deleteByIds": { - "post": { - "tags": [ - "salesRuleCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/deleteByCodes": { - "post": { - "tags": [ - "salesRuleCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/children": { - "get": { - "tags": [ - "configurableProductLinkManagementV1" - ], - "description": "Get all children for Configurable product", - "operationId": "configurableProductLinkManagementV1GetChildrenGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/children/{childSku}": { - "delete": { - "tags": [ - "configurableProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/child": { - "post": { - "tags": [ - "configurableProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/variation": { - "put": { - "tags": [ - "configurableProductConfigurableProductManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/options/{id}": { - "get": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "description": "Get option for configurable product", - "operationId": "configurableProductOptionRepositoryV1GetGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/configurable-product-data-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/options/all": { - "get": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "description": "Get all options for configurable product", - "operationId": "configurableProductOptionRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/configurable-product-data-option-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/options": { - "post": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links": { - "get": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "description": "List of links with associated samples", - "operationId": "downloadableLinkRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/downloadable-data-link-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links/{id}": { - "put": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/downloadable-links/{id}": { - "delete": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links/samples": { - "get": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "description": "List of samples for downloadable product", - "operationId": "downloadableSampleRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/downloadable-data-sample-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links/samples/{id}": { - "put": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/downloadable-links/samples/{id}": { - "delete": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/licence": { - "get": { - "tags": [ - "checkoutAgreementsCheckoutAgreementsRepositoryV1" - ], - "description": "Lists active checkout agreements.", - "operationId": "checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/checkout-agreements-data-agreement-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRates": { - "post": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRates/{rateId}": { - "get": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "description": "Get tax rate", - "operationId": "taxTaxRateRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "rateId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRates/search": { - "get": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "description": "Search TaxRates This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "taxTaxRateRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRules": { - "post": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRules/{ruleId}": { - "delete": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "description": "Get TaxRule", - "operationId": "taxTaxRuleRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "ruleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRules/search": { - "get": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "description": "Search TaxRules This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "taxTaxRuleRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses": { - "post": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "id for the newly created Tax class" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses/{taxClassId}": { - "get": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "description": "Get a tax class with the given tax class id.", - "operationId": "taxTaxClassRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "taxClassId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-class-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "True if the tax class was deleted, false otherwise" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses/{classId}": { - "put": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "id for the newly created Tax class" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses/search": { - "get": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "description": "Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "taxTaxClassRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-class-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/": { - "get": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "description": "Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included.", - "operationId": "companyCompanyRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/{companyId}": { - "get": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "description": "Returns company details.", - "operationId": "companyCompanyRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "companyId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/team/": { - "get": { - "tags": [ - "companyTeamRepositoryV1" - ], - "description": "Returns the list of teams for the specified search criteria (team name or description).", - "operationId": "companyTeamRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-team-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/team/{teamId}": { - "get": { - "tags": [ - "companyTeamRepositoryV1" - ], - "description": "Returns data for a team in the company, by entity id.", - "operationId": "companyTeamRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "teamId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-team-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "companyTeamRepositoryV1" - ], - "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": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "companyTeamRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/team/{companyId}": { - "post": { - "tags": [ - "companyTeamRepositoryV1" - ], - "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": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/hierarchy/{id}": { - "get": { - "tags": [ - "companyCompanyHierarchyV1" - ], - "description": "Returns the list of teams and company users in the company structure.", - "operationId": "companyCompanyHierarchyV1GetCompanyHierarchyGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/company-data-hierarchy-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/hierarchy/move/{id}": { - "put": { - "tags": [ - "companyCompanyHierarchyV1" - ], - "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" - } - } - } - } - }, - "/V1/company/role/": { - "get": { - "tags": [ - "companyRoleRepositoryV1" - ], - "description": "Returns the list of roles and permissions for a specified company.", - "operationId": "companyRoleRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "companyRoleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/role/{roleId}": { - "get": { - "tags": [ - "companyRoleRepositoryV1" - ], - "description": "Returns the list of permissions for a specified role.", - "operationId": "companyRoleRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "roleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "companyRoleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/role/{id}": { - "put": { - "tags": [ - "companyRoleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/assignRoles": { - "put": { - "tags": [ - "companyAclV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/role/{roleId}/users": { - "get": { - "tags": [ - "companyAclV1" - ], - "description": "View the list of company users assigned to a specified role.", - "operationId": "companyAclV1GetUsersByRoleIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "roleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-customer-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/integration/admin/token": { - "post": { - "tags": [ - "integrationAdminTokenServiceV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Token created" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/integration/customer/token": { - "post": { - "tags": [ - "integrationCustomerTokenServiceV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Token created" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/analytics/link": { - "get": { - "tags": [ - "analyticsLinkProviderV1" - ], - "description": "", - "operationId": "analyticsLinkProviderV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/analytics-data-link-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/balance/apply": { - "post": { - "tags": [ - "customerBalanceBalanceManagementFromQuoteV1" - ], - "description": "Apply store credit.", - "operationId": "customerBalanceBalanceManagementFromQuoteV1ApplyPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/balance/unapply": { - "post": { - "tags": [ - "customerBalanceBalanceManagementFromQuoteV1" - ], - "description": "Unapply store credit.", - "operationId": "customerBalanceBalanceManagementFromQuoteV1UnapplyPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/request": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuoteManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/submitToCustomer": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuoteManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/decline": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuoteManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/pricesUpdated": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuotePriceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/attachmentContent": { - "get": { - "tags": [ - "negotiableQuoteAttachmentContentManagementV1" - ], - "description": "Returns content for one or more files attached on the quote comment.", - "operationId": "negotiableQuoteAttachmentContentManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attachmentIds", - "in": "query", - "type": "array", - "items": { - "type": "integer" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/{quoteId}/comments": { - "get": { - "tags": [ - "negotiableQuoteCommentLocatorV1" - ], - "description": "Returns comments for a specified negotiable quote.", - "operationId": "negotiableQuoteCommentLocatorV1GetListForQuoteGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "quoteId", - "in": "path", - "type": "integer", - "required": true, - "description": "Negotiable Quote ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of quote comments.", - "items": { - "$ref": "#/definitions/negotiable-quote-data-comment-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/{quoteId}/shippingMethod": { - "put": { - "tags": [ - "negotiableQuoteNegotiableQuoteShippingManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/payment-information": { - "post": { - "tags": [ - "negotiableQuotePaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "negotiableQuotePaymentInformationManagementV1" - ], - "description": "Get payment information", - "operationId": "negotiableQuotePaymentInformationManagementV1GetPaymentInformationGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/set-payment-information": { - "post": { - "tags": [ - "negotiableQuotePaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/shipping-information": { - "post": { - "tags": [ - "negotiableQuoteShippingInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "negotiableQuoteShipmentEstimationV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id": { - "post": { - "tags": [ - "negotiableQuoteShippingMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/{quoteId}": { - "put": { - "tags": [ - "negotiableQuoteNegotiableCartRepositoryV1" - ], - "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" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/billing-address": { - "get": { - "tags": [ - "negotiableQuoteBillingAddressManagementV1" - ], - "description": "Returns the billing address for a specified quote.", - "operationId": "negotiableQuoteBillingAddressManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "negotiableQuoteBillingAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/totals": { - "get": { - "tags": [ - "negotiableQuoteCartTotalRepositoryV1" - ], - "description": "Returns quote totals data for a specified cart.", - "operationId": "negotiableQuoteCartTotalRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/coupons/{couponCode}": { - "put": { - "tags": [ - "negotiableQuoteCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/coupons": { - "delete": { - "tags": [ - "negotiableQuoteCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/giftCards": { - "post": { - "tags": [ - "negotiableQuoteGiftCardAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "negotiableQuoteGiftCardAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{quoteId}/giftCards": { - "get": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "Return GiftCard Account cards", - "operationId": "giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "quoteId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/giftCards": { - "put": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/giftCards": { - "post": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/checkGiftCard/{giftCardCode}": { - "get": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "", - "operationId": "giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "giftCardCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "number" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "giftCardAccountGuestGiftCardAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/guest-carts/{cartId}/giftCards": { - "post": { - "tags": [ - "giftCardAccountGuestGiftCardAccountManagementV1" - ], - "description": "", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}": { - "get": { - "tags": [ - "giftCardAccountGuestGiftCardAccountManagementV1" - ], - "description": "", - "operationId": "giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "number" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}": { - "get": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "description": "Return the following properties for the selected shared catalog: ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.", - "operationId": "sharedCatalogSharedCatalogRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sharedCatalogId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog": { - "post": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}": { - "put": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/": { - "get": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "description": "Return the list of shared catalogs and basic properties for each catalog.", - "operationId": "sharedCatalogSharedCatalogRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/shared-catalog-data-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}/companies": { - "get": { - "tags": [ - "sharedCatalogCompanyManagementV1" - ], - "description": "Return the list of company IDs for the companies assigned to the selected catalog.", - "operationId": "sharedCatalogCompanyManagementV1GetCompaniesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sharedCatalogId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}/assignCompanies": { - "post": { - "tags": [ - "sharedCatalogCompanyManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}/unassignCompanies": { - "post": { - "tags": [ - "sharedCatalogCompanyManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/products": { - "get": { - "tags": [ - "sharedCatalogProductManagementV1" - ], - "description": "Return the list of product SKUs in the selected shared catalog.", - "operationId": "sharedCatalogProductManagementV1GetProductsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/assignProducts": { - "post": { - "tags": [ - "sharedCatalogProductManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/unassignProducts": { - "post": { - "tags": [ - "sharedCatalogProductManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/categories": { - "get": { - "tags": [ - "sharedCatalogCategoryManagementV1" - ], - "description": "Return the list of categories in the selected shared catalog.", - "operationId": "sharedCatalogCategoryManagementV1GetCategoriesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "integer" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/assignCategories": { - "post": { - "tags": [ - "sharedCatalogCategoryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/unassignCategories": { - "post": { - "tags": [ - "sharedCatalogCategoryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/gift-message": { - "get": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "description": "Return the gift message for a specified order.", - "operationId": "giftMessageCartRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/gift-message": { - "get": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "description": "Return the gift message for a specified order.", - "operationId": "giftMessageCartRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/gift-message/{itemId}": { - "get": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "description": "Return the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageItemRepositoryV1GetGet", - "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": "itemId", - "in": "path", - "type": "integer", - "required": true, - "description": "The item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/gift-message/{itemId}": { - "get": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "description": "Return the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageItemRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "itemId", - "in": "path", - "type": "integer", - "required": true, - "description": "The item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/gift-message": { - "get": { - "tags": [ - "giftMessageGuestCartRepositoryV1" - ], - "description": "Return the gift message for a specified order.", - "operationId": "giftMessageGuestCartRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageGuestCartRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/gift-message/{itemId}": { - "get": { - "tags": [ - "giftMessageGuestItemRepositoryV1" - ], - "description": "Return the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageGuestItemRepositoryV1GetGet", - "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": "itemId", - "in": "path", - "type": "integer", - "required": true, - "description": "The item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageGuestItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/giftregistry/mine/estimate-shipping-methods": { - "post": { - "tags": [ - "giftRegistryShippingMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "giftRegistryGuestCartShippingMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/gift-wrappings/{id}": { - "get": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "description": "Return data object for specified wrapping ID and store.", - "operationId": "giftWrappingWrappingRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/gift-wrappings": { - "post": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "description": "Return list of gift wrapping data objects based on search criteria", - "operationId": "giftWrappingWrappingRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/gift-wrappings/{wrappingId}": { - "put": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/reward/mine/use-reward": { - "post": { - "tags": [ - "rewardRewardManagementV1" - ], - "description": "Set reward points to quote", - "operationId": "rewardRewardManagementV1SetPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/tracking-numbers": { - "post": { - "tags": [ - "rmaTrackManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "rmaTrackManagementV1" - ], - "description": "Get track list", - "operationId": "rmaTrackManagementV1GetTracksGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-track-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/tracking-numbers/{trackId}": { - "delete": { - "tags": [ - "rmaTrackManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/labels": { - "get": { - "tags": [ - "rmaTrackManagementV1" - ], - "description": "Get shipping label int the PDF format", - "operationId": "rmaTrackManagementV1GetShippingLabelPdfGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}": { - "get": { - "tags": [ - "rmaRmaRepositoryV1" - ], - "description": "Return data object for specified RMA id", - "operationId": "rmaRmaRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "rmaRmaRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "rmaRmaManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/comments": { - "post": { - "tags": [ - "rmaCommentManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "rmaCommentManagementV1" - ], - "description": "Comments list", - "operationId": "rmaCommentManagementV1CommentsListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns": { - "post": { - "tags": [ - "rmaRmaManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "rmaRmaManagementV1" - ], - "description": "Return list of rma data objects based on search criteria", - "operationId": "rmaRmaManagementV1SearchGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata/{attributeCode}": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Retrieve attribute metadata.", - "operationId": "rmaRmaAttributesManagementV1GetAttributeMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata/form/{formCode}": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Retrieve all attributes filtered by form code", - "operationId": "rmaRmaAttributesManagementV1GetAttributesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "formCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Get all attribute metadata.", - "operationId": "rmaRmaAttributesManagementV1GetAllAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata/custom": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Get custom attribute metadata for the given Data object's attribute set", - "operationId": "rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "dataObjectClassName", - "in": "query", - "type": "string", - "description": "Data object class name", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-metadata-object-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/": { - "get": { - "tags": [ - "companyCreditCreditLimitRepositoryV1" - ], - "description": "Returns the list of credits for specified companies.", - "operationId": "companyCreditCreditLimitRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{creditId}": { - "get": { - "tags": [ - "companyCreditCreditLimitRepositoryV1" - ], - "description": "Returns data on the credit limit for a specified credit limit ID.", - "operationId": "companyCreditCreditLimitRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "creditId", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "reload", - "in": "query", - "type": "boolean", - "description": "[optional]", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{id}": { - "put": { - "tags": [ - "companyCreditCreditLimitRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/company/{companyId}": { - "get": { - "tags": [ - "companyCreditCreditLimitManagementV1" - ], - "description": "Returns data on the credit limit for a specified company.", - "operationId": "companyCreditCreditLimitManagementV1GetCreditByCompanyIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "companyId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{creditId}/increaseBalance": { - "post": { - "tags": [ - "companyCreditCreditBalanceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{creditId}/decreaseBalance": { - "post": { - "tags": [ - "companyCreditCreditBalanceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/history": { - "get": { - "tags": [ - "companyCreditCreditHistoryManagementV1" - ], - "description": "Returns the credit history for one or more companies.", - "operationId": "companyCreditCreditHistoryManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-history-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/history/{historyId}": { - "put": { - "tags": [ - "companyCreditCreditHistoryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bulk/{bulkUuid}/detailed-status": { - "get": { - "tags": [ - "asynchronousOperationsBulkStatusV1" - ], - "description": "Get Bulk summary data with list of operations items full data.", - "operationId": "asynchronousOperationsBulkStatusV1GetBulkDetailedStatusGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "bulkUuid", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/asynchronous-operations-data-detailed-bulk-operations-status-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bulk/{bulkUuid}/status": { - "get": { - "tags": [ - "asynchronousOperationsBulkStatusV1" - ], - "description": "Get Bulk summary data with list of operations items short data.", - "operationId": "asynchronousOperationsBulkStatusV1GetBulkShortStatusGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "bulkUuid", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/asynchronous-operations-data-bulk-operations-status-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bulk/{bulkUuid}/operation-status/{status}": { - "get": { - "tags": [ - "asynchronousOperationsBulkStatusV1" - ], - "description": "Get operations count by bulk uuid and status.", - "operationId": "asynchronousOperationsBulkStatusV1GetOperationsCountByBulkIdAndStatusGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "bulkUuid", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "status", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/worldpay-guest-carts/{cartId}/payment-information": { - "post": { - "tags": [ - "worldpayGuestPaymentInformationManagementProxyV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/amazon-shipping-address/{amazonOrderReferenceId}": { - "put": { - "tags": [ - "amazonPaymentAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/amazon-billing-address/{amazonOrderReferenceId}": { - "put": { - "tags": [ - "amazonPaymentAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/amazon/order-ref": { - "delete": { - "tags": [ - "amazonPaymentOrderInformationManagementV1" - ], - "description": "", - "operationId": "amazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/delivery-option": { - "post": { - "tags": [ - "temandoShippingQuoteCartDeliveryOptionManagementV1" - ], - "description": "Handle selected delivery option.", - "operationId": "temandoShippingQuoteCartDeliveryOptionManagementV1SavePost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "temandoShippingQuoteCartDeliveryOptionManagementV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "selectedOption" - ], - "properties": { - "selectedOption": { - "type": "string" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/delivery-option": { - "post": { - "tags": [ - "temandoShippingQuoteGuestCartDeliveryOptionManagementV1" - ], - "description": "Handle selected delivery option.", - "operationId": "temandoShippingQuoteGuestCartDeliveryOptionManagementV1SavePost", - "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": "temandoShippingQuoteGuestCartDeliveryOptionManagementV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "selectedOption" - ], - "properties": { - "selectedOption": { - "type": "string" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/temando/rma/{rmaId}/shipments": { - "put": { - "tags": [ - "temandoShippingRmaRmaShipmentManagementV1" - ], - "description": "Assign platform shipment IDs to a core RMA entity.", - "operationId": "temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPut", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "rmaId", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPutBody", - "in": "body", - "schema": { - "required": [ - "returnShipmentIds" - ], - "properties": { - "returnShipmentIds": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Number of successfully assigned shipment IDs." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collection-point/search-request": { - "put": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SaveSearchRequestPut", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SaveSearchRequestPutBody", - "in": "body", - "schema": { - "required": [ - "countryId", - "postcode" - ], - "properties": { - "countryId": { - "type": "string" - }, - "postcode": { - "type": "string" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/temando-shipping-data-collection-point-search-request-interface" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1DeleteSearchRequestDelete", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collection-point/search-result": { - "get": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1GetCollectionPointsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/temando-shipping-data-collection-point-quote-collection-point-interface" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collection-point/select": { - "post": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SelectCollectionPointPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SelectCollectionPointPostBody", - "in": "body", - "schema": { - "required": [ - "entityId" - ], - "properties": { - "entityId": { - "type": "integer" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collection-point/search-request": { - "put": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1SaveSearchRequestPut", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "temandoShippingCollectionPointCartCollectionPointManagementV1SaveSearchRequestPutBody", - "in": "body", - "schema": { - "required": [ - "countryId", - "postcode" - ], - "properties": { - "countryId": { - "type": "string" - }, - "postcode": { - "type": "string" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/temando-shipping-data-collection-point-search-request-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1DeleteSearchRequestDelete", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collection-point/search-result": { - "get": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1GetCollectionPointsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/temando-shipping-data-collection-point-quote-collection-point-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collection-point/select": { - "post": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1SelectCollectionPointPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "temandoShippingCollectionPointCartCollectionPointManagementV1SelectCollectionPointPostBody", - "in": "body", - "schema": { - "required": [ - "entityId" - ], - "properties": { - "entityId": { - "type": "integer" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/checkout-fields": { - "post": { - "tags": [ - "temandoShippingQuoteGuestCartCheckoutFieldManagementV1" - ], - "description": "", - "operationId": "temandoShippingQuoteGuestCartCheckoutFieldManagementV1SaveCheckoutFieldsPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "temandoShippingQuoteGuestCartCheckoutFieldManagementV1SaveCheckoutFieldsPostBody", - "in": "body", - "schema": { - "required": [ - "serviceSelection" - ], - "properties": { - "serviceSelection": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/checkout-fields": { - "post": { - "tags": [ - "temandoShippingQuoteCartCheckoutFieldManagementV1" - ], - "description": "", - "operationId": "temandoShippingQuoteCartCheckoutFieldManagementV1SaveCheckoutFieldsPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "temandoShippingQuoteCartCheckoutFieldManagementV1SaveCheckoutFieldsPostBody", - "in": "body", - "schema": { - "required": [ - "serviceSelection" - ], - "properties": { - "serviceSelection": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - } - }, - "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" - } - } - }, - "store-data-store-interface": { - "type": "object", - "description": "Store interface", - "properties": { - "id": { - "type": "integer" - }, - "code": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Store name" - }, - "website_id": { - "type": "integer" - }, - "store_group_id": { - "type": "integer" - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-store-extension-interface" - } - }, - "required": [ - "id", - "code", - "name", - "website_id", - "store_group_id" - ] - }, - "store-data-store-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface" - }, - "store-data-group-interface": { - "type": "object", - "description": "Group interface", - "properties": { - "id": { - "type": "integer" - }, - "website_id": { - "type": "integer" - }, - "root_category_id": { - "type": "integer" - }, - "default_store_id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "code": { - "type": "string", - "description": "Group code." - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-group-extension-interface" - } - }, - "required": [ - "id", - "website_id", - "root_category_id", - "default_store_id", - "name", - "code" - ] - }, - "store-data-group-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface" - }, - "store-data-website-interface": { - "type": "object", - "description": "Website interface", - "properties": { - "id": { - "type": "integer" - }, - "code": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Website name" - }, - "default_group_id": { - "type": "integer" - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-website-extension-interface" - } - }, - "required": [ - "id", - "code", - "name", - "default_group_id" - ] - }, - "store-data-website-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface" - }, - "store-data-store-config-interface": { - "type": "object", - "description": "StoreConfig interface", - "properties": { - "id": { - "type": "integer", - "description": "Store id" - }, - "code": { - "type": "string", - "description": "Store code" - }, - "website_id": { - "type": "integer", - "description": "Website id of the store" - }, - "locale": { - "type": "string", - "description": "Store locale" - }, - "base_currency_code": { - "type": "string", - "description": "Base currency code" - }, - "default_display_currency_code": { - "type": "string", - "description": "Default display currency code" - }, - "timezone": { - "type": "string", - "description": "Timezone of the store" - }, - "weight_unit": { - "type": "string", - "description": "The unit of weight" - }, - "base_url": { - "type": "string", - "description": "Base URL for the store" - }, - "base_link_url": { - "type": "string", - "description": "Base link URL for the store" - }, - "base_static_url": { - "type": "string", - "description": "Base static URL for the store" - }, - "base_media_url": { - "type": "string", - "description": "Base media URL for the store" - }, - "secure_base_url": { - "type": "string", - "description": "Secure base URL for the store" - }, - "secure_base_link_url": { - "type": "string", - "description": "Secure base link URL for the store" - }, - "secure_base_static_url": { - "type": "string", - "description": "Secure base static URL for the store" - }, - "secure_base_media_url": { - "type": "string", - "description": "Secure base media URL for the store" - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-store-config-extension-interface" - } - }, - "required": [ - "id", - "code", - "website_id", - "locale", - "base_currency_code", - "default_display_currency_code", - "timezone", - "weight_unit", - "base_url", - "base_link_url", - "base_static_url", - "base_media_url", - "secure_base_url", - "secure_base_link_url", - "secure_base_static_url", - "secure_base_media_url" - ] - }, - "store-data-store-config-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface" - }, - "directory-data-currency-information-interface": { - "type": "object", - "description": "Currency Information interface.", - "properties": { - "base_currency_code": { - "type": "string", - "description": "The base currency code for the store." - }, - "base_currency_symbol": { - "type": "string", - "description": "The currency symbol of the base currency for the store." - }, - "default_display_currency_code": { - "type": "string", - "description": "The default display currency code for the store." - }, - "default_display_currency_symbol": { - "type": "string", - "description": "The currency symbol of the default display currency for the store." - }, - "available_currency_codes": { - "type": "array", - "description": "The list of allowed currency codes for the store.", - "items": { - "type": "string" - } - }, - "exchange_rates": { - "type": "array", - "description": "The list of exchange rate information for the store.", - "items": { - "$ref": "#/definitions/directory-data-exchange-rate-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-currency-information-extension-interface" - } - }, - "required": [ - "base_currency_code", - "base_currency_symbol", - "default_display_currency_code", - "default_display_currency_symbol", - "available_currency_codes", - "exchange_rates" - ] - }, - "directory-data-exchange-rate-interface": { - "type": "object", - "description": "Exchange Rate interface.", - "properties": { - "currency_to": { - "type": "string", - "description": "The currency code associated with the exchange rate." - }, - "rate": { - "type": "number", - "description": "The exchange rate for the associated currency and the store's base currency." - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-exchange-rate-extension-interface" - } - }, - "required": [ - "currency_to", - "rate" - ] - }, - "directory-data-exchange-rate-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface" - }, - "directory-data-currency-information-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface" - }, - "directory-data-country-information-interface": { - "type": "object", - "description": "Country Information interface.", - "properties": { - "id": { - "type": "string", - "description": "The country id for the store." - }, - "two_letter_abbreviation": { - "type": "string", - "description": "The country 2 letter abbreviation for the store." - }, - "three_letter_abbreviation": { - "type": "string", - "description": "The country 3 letter abbreviation for the store." - }, - "full_name_locale": { - "type": "string", - "description": "The country full name (in store locale) for the store." - }, - "full_name_english": { - "type": "string", - "description": "The country full name (in English) for the store." - }, - "available_regions": { - "type": "array", - "description": "The available regions for the store.", - "items": { - "$ref": "#/definitions/directory-data-region-information-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-country-information-extension-interface" - } - }, - "required": [ - "id", - "two_letter_abbreviation", - "three_letter_abbreviation", - "full_name_locale", - "full_name_english" - ] - }, - "directory-data-region-information-interface": { - "type": "object", - "description": "Region Information interface.", - "properties": { - "id": { - "type": "string", - "description": "Region id" - }, - "code": { - "type": "string", - "description": "Region code" - }, - "name": { - "type": "string", - "description": "Region name" - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-region-information-extension-interface" - } - }, - "required": [ - "id", - "code", - "name" - ] - }, - "directory-data-region-information-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface" - }, - "directory-data-country-information-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface" - }, - "eav-data-attribute-set-search-results-interface": { - "type": "object", - "description": "Interface AttributeSetSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Attribute sets list.", - "items": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "framework-search-criteria-interface": { - "type": "object", - "description": "Search criteria interface.", - "properties": { - "filter_groups": { - "type": "array", - "description": "A list of filter groups.", - "items": { - "$ref": "#/definitions/framework-search-filter-group" - } - }, - "sort_orders": { - "type": "array", - "description": "Sort order.", - "items": { - "$ref": "#/definitions/framework-sort-order" - } - }, - "page_size": { - "type": "integer", - "description": "Page size." - }, - "current_page": { - "type": "integer", - "description": "Current page." - } - }, - "required": [ - "filter_groups" - ] - }, - "framework-search-filter-group": { - "type": "object", - "description": "Groups two or more filters together using a logical OR", - "properties": { - "filters": { - "type": "array", - "description": "A list of filters in this group", - "items": { - "$ref": "#/definitions/framework-filter" - } - } - } - }, - "framework-filter": { - "type": "object", - "description": "Filter which can be used by any methods from service layer.", - "properties": { - "field": { - "type": "string", - "description": "Field" - }, - "value": { - "type": "string", - "description": "Value" - }, - "condition_type": { - "type": "string", - "description": "Condition type" - } - }, - "required": [ - "field", - "value" - ] - }, - "framework-sort-order": { - "type": "object", - "description": "Data object for sort order.", - "properties": { - "field": { - "type": "string", - "description": "Sorting field." - }, - "direction": { - "type": "string", - "description": "Sorting direction." - } - }, - "required": [ - "field", - "direction" - ] - }, - "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-group-search-results-interface": { - "type": "object", - "description": "Interface for customer groups search results.", - "properties": { - "items": { - "type": "array", - "description": "Customer groups list.", - "items": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "customer-data-attribute-metadata-interface": { - "type": "object", - "description": "Customer attribute metadata interface.", - "properties": { - "frontend_input": { - "type": "string", - "description": "HTML for input element." - }, - "input_filter": { - "type": "string", - "description": "Template used for input (e.g. \"date\")" - }, - "store_label": { - "type": "string", - "description": "Label of the store." - }, - "validation_rules": { - "type": "array", - "description": "Validation rules.", - "items": { - "$ref": "#/definitions/customer-data-validation-rule-interface" - } - }, - "multiline_count": { - "type": "integer", - "description": "Of lines of the attribute value." - }, - "visible": { - "type": "boolean", - "description": "Attribute is visible on frontend." - }, - "required": { - "type": "boolean", - "description": "Attribute is required." - }, - "data_model": { - "type": "string", - "description": "Data model for attribute." - }, - "options": { - "type": "array", - "description": "Options of the attribute (key => value pairs for select)", - "items": { - "$ref": "#/definitions/customer-data-option-interface" - } - }, - "frontend_class": { - "type": "string", - "description": "Class which is used to display the attribute on frontend." - }, - "user_defined": { - "type": "boolean", - "description": "Current attribute has been defined by a user." - }, - "sort_order": { - "type": "integer", - "description": "Attributes sort order." - }, - "frontend_label": { - "type": "string", - "description": "Label which supposed to be displayed on frontend." - }, - "note": { - "type": "string", - "description": "The note attribute for the element." - }, - "system": { - "type": "boolean", - "description": "This is a system attribute." - }, - "backend_type": { - "type": "string", - "description": "Backend type." - }, - "is_used_in_grid": { - "type": "boolean", - "description": "It is used in customer grid" - }, - "is_visible_in_grid": { - "type": "boolean", - "description": "It is visible in customer grid" - }, - "is_filterable_in_grid": { - "type": "boolean", - "description": "It is filterable in customer grid" - }, - "is_searchable_in_grid": { - "type": "boolean", - "description": "It is searchable in customer grid" - }, - "attribute_code": { - "type": "string", - "description": "Code of the attribute." - } - }, - "required": [ - "frontend_input", - "input_filter", - "store_label", - "validation_rules", - "multiline_count", - "visible", - "required", - "data_model", - "options", - "frontend_class", - "user_defined", - "sort_order", - "frontend_label", - "note", - "system", - "backend_type", - "attribute_code" - ] - }, - "customer-data-validation-rule-interface": { - "type": "object", - "description": "Validation rule interface.", - "properties": { - "name": { - "type": "string", - "description": "Validation rule name" - }, - "value": { - "type": "string", - "description": "Validation rule value" - } - }, - "required": [ - "name", - "value" - ] - }, - "customer-data-option-interface": { - "type": "object", - "description": "Option interface.", - "properties": { - "label": { - "type": "string", - "description": "Option label" - }, - "value": { - "type": "string", - "description": "Option value" - }, - "options": { - "type": "array", - "description": "Nested options", - "items": { - "$ref": "#/definitions/customer-data-option-interface" - } - } - }, - "required": [ - "label" - ] - }, - "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" - }, - "customer-data-customer-search-results-interface": { - "type": "object", - "description": "Interface for customer search results.", - "properties": { - "items": { - "type": "array", - "description": "Customers list.", - "items": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "customer-data-validation-results-interface": { - "type": "object", - "description": "Validation results interface.", - "properties": { - "valid": { - "type": "boolean", - "description": "If the provided data is valid." - }, - "messages": { - "type": "array", - "description": "Error messages as array in case of validation failure, else return empty array.", - "items": { - "type": "string" - } - } - }, - "required": [ - "valid", - "messages" - ] - }, - "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-page-search-results-interface": { - "type": "object", - "description": "Interface for cms page search results.", - "properties": { - "items": { - "type": "array", - "description": "Pages list.", - "items": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - ] - }, - "cms-data-block-search-results-interface": { - "type": "object", - "description": "Interface for cms block search results.", - "properties": { - "items": { - "type": "array", - "description": "Blocks list.", - "items": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - } - }, - "bundle_product_options": { - "type": "array", - "items": { - "$ref": "#/definitions/bundle-data-option-interface" - } - }, - "stock_item": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-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" - }, - "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" - }, - "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" - }, - "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" - }, - "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-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Attributes list.", - "items": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-product-attribute-type-interface": { - "type": "object", - "description": "", - "properties": { - "value": { - "type": "string", - "description": "Value" - }, - "label": { - "type": "string", - "description": "Type label" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-attribute-type-extension-interface" - } - }, - "required": [ - "value", - "label" - ] - }, - "catalog-data-product-attribute-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface" - }, - "catalog-data-product-attribute-interface": { - "type": "object", - "description": "", - "properties": { - "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" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-eav-attribute-extension-interface" - }, - "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" - ] - }, - "catalog-data-eav-attribute-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface" - }, - "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" - ] - }, - "catalog-data-product-attribute-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Attributes list.", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-category-attribute-interface": { - "type": "object", - "description": "", - "properties": { - "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" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-eav-attribute-extension-interface" - }, - "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" - ] - }, - "catalog-data-category-attribute-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Attributes list.", - "items": { - "$ref": "#/definitions/catalog-data-category-attribute-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-product-type-interface": { - "type": "object", - "description": "Product type details", - "properties": { - "name": { - "type": "string", - "description": "Product type code" - }, - "label": { - "type": "string", - "description": "Product type label" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-type-extension-interface" - } - }, - "required": [ - "name", - "label" - ] - }, - "catalog-data-product-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface" - }, - "eav-data-attribute-group-search-results-interface": { - "type": "object", - "description": "Interface AttributeGroupSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Attribute sets list.", - "items": { - "$ref": "#/definitions/eav-data-attribute-group-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-price-update-result-interface": { - "type": "object", - "description": "Interface returned in case of incorrect price passed to efficient price API.", - "properties": { - "message": { - "type": "string", - "description": "Error message, that contains description of error occurred during price update." - }, - "parameters": { - "type": "array", - "description": "Parameters, that could be displayed in error message placeholders.", - "items": { - "type": "string" - } - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-price-update-result-extension-interface" - } - }, - "required": [ - "message", - "parameters" - ] - }, - "catalog-data-price-update-result-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface" - }, - "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": "", - "properties": { - "id": { - "type": "integer" - }, - "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" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "path": { - "type": "string" - }, - "available_sort_by": { - "type": "array", - "items": { - "type": "string" - } - }, - "include_in_menu": { - "type": "boolean" - }, - "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-tree-interface": { - "type": "object", - "description": "", - "properties": { - "id": { - "type": "integer" - }, - "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" - }, - "product_count": { - "type": "integer", - "description": "Product count" - }, - "children_data": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-category-tree-interface" - } - } - }, - "required": [ - "parent_id", - "name", - "is_active", - "position", - "level", - "product_count", - "children_data" - ] - }, - "catalog-data-category-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Categories", - "items": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-product-custom-option-type-interface": { - "type": "object", - "description": "", - "properties": { - "label": { - "type": "string", - "description": "Option type label" - }, - "code": { - "type": "string", - "description": "Option type code" - }, - "group": { - "type": "string", - "description": "Option type group" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-custom-option-type-extension-interface" - } - }, - "required": [ - "label", - "code", - "group" - ] - }, - "catalog-data-product-custom-option-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface" - }, - "catalog-data-product-link-type-interface": { - "type": "object", - "description": "", - "properties": { - "code": { - "type": "integer", - "description": "Link type code" - }, - "name": { - "type": "string", - "description": "Link type name" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-link-type-extension-interface" - } - }, - "required": [ - "code", - "name" - ] - }, - "catalog-data-product-link-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface" - }, - "catalog-data-product-link-attribute-interface": { - "type": "object", - "description": "", - "properties": { - "code": { - "type": "string", - "description": "Attribute code" - }, - "type": { - "type": "string", - "description": "Attribute type" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-link-attribute-extension-interface" - } - }, - "required": [ - "code", - "type" - ] - }, - "catalog-data-product-link-attribute-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface" - }, - "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" - ] - }, - "catalog-data-product-render-search-results-interface": { - "type": "object", - "description": "Dto that holds render information about products", - "properties": { - "items": { - "type": "array", - "description": "List of products rendered information", - "items": { - "$ref": "#/definitions/catalog-data-product-render-interface" - } - } - }, - "required": [ - "items" - ] - }, - "catalog-data-product-render-interface": { - "type": "object", - "description": "Represents Data Object which holds enough information to render product This information is put into part as Add To Cart or Add to Compare Data or Price Data", - "properties": { - "add_to_cart_button": { - "$ref": "#/definitions/catalog-data-product-render-button-interface" - }, - "add_to_compare_button": { - "$ref": "#/definitions/catalog-data-product-render-button-interface" - }, - "price_info": { - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - }, - "images": { - "type": "array", - "description": "Enough information, that needed to render image on front", - "items": { - "$ref": "#/definitions/catalog-data-product-render-image-interface" - } - }, - "url": { - "type": "string", - "description": "Product url" - }, - "id": { - "type": "integer", - "description": "Product identifier" - }, - "name": { - "type": "string", - "description": "Product name" - }, - "type": { - "type": "string", - "description": "Product type. Such as bundle, grouped, simple, etc..." - }, - "is_salable": { - "type": "string", - "description": "Information about product saleability (In Stock)" - }, - "store_id": { - "type": "integer", - "description": "Information about current store id or requested store id" - }, - "currency_code": { - "type": "string", - "description": "Current or desired currency code to product" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-extension-interface" - } - }, - "required": [ - "add_to_cart_button", - "add_to_compare_button", - "price_info", - "images", - "url", - "id", - "name", - "type", - "is_salable", - "store_id", - "currency_code", - "extension_attributes" - ] - }, - "catalog-data-product-render-button-interface": { - "type": "object", - "description": "Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend", - "properties": { - "post_data": { - "type": "string", - "description": "Post data" - }, - "url": { - "type": "string", - "description": "Url, needed to add product to cart" - }, - "required_options": { - "type": "boolean", - "description": "Flag whether a product has options or not" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-button-extension-interface" - } - }, - "required": [ - "post_data", - "url", - "required_options" - ] - }, - "catalog-data-product-render-button-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ButtonInterface" - }, - "catalog-data-product-render-price-info-interface": { - "type": "object", - "description": "Price interface.", - "properties": { - "final_price": { - "type": "number", - "description": "Final price" - }, - "max_price": { - "type": "number", - "description": "Max price of a product" - }, - "max_regular_price": { - "type": "number", - "description": "Max regular price" - }, - "minimal_regular_price": { - "type": "number", - "description": "Minimal regular price" - }, - "special_price": { - "type": "number", - "description": "Special price" - }, - "minimal_price": { - "type": "number" - }, - "regular_price": { - "type": "number", - "description": "Regular price" - }, - "formatted_prices": { - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface" - } - }, - "required": [ - "final_price", - "max_price", - "max_regular_price", - "minimal_regular_price", - "special_price", - "minimal_price", - "regular_price", - "formatted_prices" - ] - }, - "catalog-data-product-render-formatted-price-info-interface": { - "type": "object", - "description": "Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html", - "properties": { - "final_price": { - "type": "string", - "description": "Html with final price" - }, - "max_price": { - "type": "string", - "description": "Max price of a product" - }, - "minimal_price": { - "type": "string", - "description": "The minimal price of the product or variation" - }, - "max_regular_price": { - "type": "string", - "description": "Max regular price" - }, - "minimal_regular_price": { - "type": "string", - "description": "Minimal regular price" - }, - "special_price": { - "type": "string", - "description": "Special price" - }, - "regular_price": { - "type": "string", - "description": "Price - is price of product without discounts and special price with taxes and fixed product tax" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface" - } - }, - "required": [ - "final_price", - "max_price", - "minimal_price", - "max_regular_price", - "minimal_regular_price", - "special_price", - "regular_price" - ] - }, - "catalog-data-product-render-formatted-price-info-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\FormattedPriceInfoInterface" - }, - "catalog-data-product-render-price-info-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\PriceInfoInterface", - "properties": { - "msrp": { - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface" - }, - "tax_adjustments": { - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - }, - "weee_attributes": { - "type": "array", - "items": { - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface" - } - }, - "weee_adjustment": { - "type": "string" - } - } - }, - "msrp-data-product-render-msrp-price-info-interface": { - "type": "object", - "description": "Price interface.", - "properties": { - "msrp_price": { - "type": "string" - }, - "is_applicable": { - "type": "string" - }, - "is_shown_price_on_gesture": { - "type": "string" - }, - "msrp_message": { - "type": "string" - }, - "explanation_message": { - "type": "string" - }, - "extension_attributes": { - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface" - } - }, - "required": [ - "msrp_price", - "is_applicable", - "is_shown_price_on_gesture", - "msrp_message", - "explanation_message" - ] - }, - "msrp-data-product-render-msrp-price-info-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Msrp\\Api\\Data\\ProductRender\\MsrpPriceInfoInterface" - }, - "weee-data-product-render-weee-adjustment-attribute-interface": { - "type": "object", - "description": "List of all weee attributes, their amounts, etc.., that product has", - "properties": { - "amount": { - "type": "string", - "description": "Weee attribute amount" - }, - "tax_amount": { - "type": "string", - "description": "Tax which is calculated to fixed product tax attribute" - }, - "tax_amount_incl_tax": { - "type": "string", - "description": "Tax amount of weee attribute" - }, - "amount_excl_tax": { - "type": "string", - "description": "Product amount exclude tax" - }, - "attribute_code": { - "type": "string", - "description": "Weee attribute code" - }, - "extension_attributes": { - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface" - } - }, - "required": [ - "amount", - "tax_amount", - "tax_amount_incl_tax", - "amount_excl_tax", - "attribute_code", - "extension_attributes" - ] - }, - "weee-data-product-render-weee-adjustment-attribute-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Weee\\Api\\Data\\ProductRender\\WeeeAdjustmentAttributeInterface" - }, - "catalog-data-product-render-image-interface": { - "type": "object", - "description": "Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view", - "properties": { - "url": { - "type": "string", - "description": "Image url" - }, - "code": { - "type": "string", - "description": "Image code" - }, - "height": { - "type": "number", - "description": "Image height" - }, - "width": { - "type": "number", - "description": "Image width in px" - }, - "label": { - "type": "string", - "description": "Image label" - }, - "resized_width": { - "type": "number", - "description": "Resize width" - }, - "resized_height": { - "type": "number", - "description": "Resize height" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-image-extension-interface" - } - }, - "required": [ - "url", - "code", - "height", - "width", - "label", - "resized_width", - "resized_height" - ] - }, - "catalog-data-product-render-image-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ImageInterface" - }, - "catalog-data-product-render-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRenderInterface", - "properties": { - "wishlist_button": { - "$ref": "#/definitions/catalog-data-product-render-button-interface" - }, - "review_html": { - "type": "string" - } - } - }, - "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" - }, - "quote-data-cart-item-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface", - "properties": { - "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-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": { - "gift_registry_id": { - "type": "integer" - }, - "checkout_fields": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - } - }, - "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": { - "type": "string" - } - } - }, - "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" - }, - "quote-data-cart-search-results-interface": { - "type": "object", - "description": "Interface CartSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Carts list.", - "items": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-shipping-method-interface": { - "type": "object", - "description": "Interface ShippingMethodInterface", - "properties": { - "carrier_code": { - "type": "string", - "description": "Shipping carrier code." - }, - "method_code": { - "type": "string", - "description": "Shipping method code." - }, - "carrier_title": { - "type": "string", - "description": "Shipping carrier title. Otherwise, null." - }, - "method_title": { - "type": "string", - "description": "Shipping method title. Otherwise, null." - }, - "amount": { - "type": "number", - "description": "Shipping amount in store currency." - }, - "base_amount": { - "type": "number", - "description": "Shipping amount in base currency." - }, - "available": { - "type": "boolean", - "description": "The value of the availability flag for the current shipping method." - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-shipping-method-extension-interface" - }, - "error_message": { - "type": "string", - "description": "Shipping Error message." - }, - "price_excl_tax": { - "type": "number", - "description": "Shipping price excl tax." - }, - "price_incl_tax": { - "type": "number", - "description": "Shipping price incl tax." - } - }, - "required": [ - "carrier_code", - "method_code", - "amount", - "base_amount", - "available", - "error_message", - "price_excl_tax", - "price_incl_tax" - ] - }, - "quote-data-shipping-method-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface" - }, - "quote-data-payment-method-interface": { - "type": "object", - "description": "Interface PaymentMethodInterface", - "properties": { - "code": { - "type": "string", - "description": "Payment method code" - }, - "title": { - "type": "string", - "description": "Payment method title" - } - }, - "required": [ - "code", - "title" - ] - }, - "quote-data-totals-interface": { - "type": "object", - "description": "Interface TotalsInterface", - "properties": { - "grand_total": { - "type": "number", - "description": "Grand total in quote currency" - }, - "base_grand_total": { - "type": "number", - "description": "Grand total in base currency" - }, - "subtotal": { - "type": "number", - "description": "Subtotal in quote currency" - }, - "base_subtotal": { - "type": "number", - "description": "Subtotal in base currency" - }, - "discount_amount": { - "type": "number", - "description": "Discount amount in quote currency" - }, - "base_discount_amount": { - "type": "number", - "description": "Discount amount in base currency" - }, - "subtotal_with_discount": { - "type": "number", - "description": "Subtotal in quote currency with applied discount" - }, - "base_subtotal_with_discount": { - "type": "number", - "description": "Subtotal in base currency with applied discount" - }, - "shipping_amount": { - "type": "number", - "description": "Shipping amount in quote currency" - }, - "base_shipping_amount": { - "type": "number", - "description": "Shipping amount in base currency" - }, - "shipping_discount_amount": { - "type": "number", - "description": "Shipping discount amount in quote currency" - }, - "base_shipping_discount_amount": { - "type": "number", - "description": "Shipping discount amount in base currency" - }, - "tax_amount": { - "type": "number", - "description": "Tax amount in quote currency" - }, - "base_tax_amount": { - "type": "number", - "description": "Tax amount in base currency" - }, - "weee_tax_applied_amount": { - "type": "number", - "description": "Item weee tax applied amount in quote currency." - }, - "shipping_tax_amount": { - "type": "number", - "description": "Shipping tax amount in quote currency" - }, - "base_shipping_tax_amount": { - "type": "number", - "description": "Shipping tax amount in base currency" - }, - "subtotal_incl_tax": { - "type": "number", - "description": "Subtotal including tax in quote currency" - }, - "base_subtotal_incl_tax": { - "type": "number", - "description": "Subtotal including tax in base currency" - }, - "shipping_incl_tax": { - "type": "number", - "description": "Shipping including tax in quote currency" - }, - "base_shipping_incl_tax": { - "type": "number", - "description": "Shipping including tax in base currency" - }, - "base_currency_code": { - "type": "string", - "description": "Base currency code" - }, - "quote_currency_code": { - "type": "string", - "description": "Quote currency code" - }, - "coupon_code": { - "type": "string", - "description": "Applied coupon code" - }, - "items_qty": { - "type": "integer", - "description": "Items qty" - }, - "items": { - "type": "array", - "description": "Totals by items", - "items": { - "$ref": "#/definitions/quote-data-totals-item-interface" - } - }, - "total_segments": { - "type": "array", - "description": "Dynamically calculated totals", - "items": { - "$ref": "#/definitions/quote-data-total-segment-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-totals-extension-interface" - } - }, - "required": [ - "weee_tax_applied_amount", - "total_segments" - ] - }, - "quote-data-totals-item-interface": { - "type": "object", - "description": "Interface TotalsItemInterface", - "properties": { - "item_id": { - "type": "integer", - "description": "Item id" - }, - "price": { - "type": "number", - "description": "Item price in quote currency." - }, - "base_price": { - "type": "number", - "description": "Item price in base currency." - }, - "qty": { - "type": "number", - "description": "Item quantity." - }, - "row_total": { - "type": "number", - "description": "Row total in quote currency." - }, - "base_row_total": { - "type": "number", - "description": "Row total in base currency." - }, - "row_total_with_discount": { - "type": "number", - "description": "Row total with discount in quote currency. Otherwise, null." - }, - "tax_amount": { - "type": "number", - "description": "Tax amount in quote currency. Otherwise, null." - }, - "base_tax_amount": { - "type": "number", - "description": "Tax amount in base currency. Otherwise, null." - }, - "tax_percent": { - "type": "number", - "description": "Tax percent. Otherwise, null." - }, - "discount_amount": { - "type": "number", - "description": "Discount amount in quote currency. Otherwise, null." - }, - "base_discount_amount": { - "type": "number", - "description": "Discount amount in base currency. Otherwise, null." - }, - "discount_percent": { - "type": "number", - "description": "Discount percent. Otherwise, null." - }, - "price_incl_tax": { - "type": "number", - "description": "Price including tax in quote currency. Otherwise, null." - }, - "base_price_incl_tax": { - "type": "number", - "description": "Price including tax in base currency. Otherwise, null." - }, - "row_total_incl_tax": { - "type": "number", - "description": "Row total including tax in quote currency. Otherwise, null." - }, - "base_row_total_incl_tax": { - "type": "number", - "description": "Row total including tax in base currency. Otherwise, null." - }, - "options": { - "type": "string", - "description": "Item price in quote currency." - }, - "weee_tax_applied_amount": { - "type": "number", - "description": "Item weee tax applied amount in quote currency." - }, - "weee_tax_applied": { - "type": "string", - "description": "Item weee tax applied in quote currency." - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-totals-item-extension-interface" - }, - "name": { - "type": "string", - "description": "Product name. Otherwise, null." - } - }, - "required": [ - "item_id", - "price", - "base_price", - "qty", - "row_total", - "base_row_total", - "options", - "weee_tax_applied_amount", - "weee_tax_applied" - ] - }, - "quote-data-totals-item-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface", - "properties": { - "negotiable_quote_item_totals": { - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface" - } - } - }, - "negotiable-quote-data-negotiable-quote-item-totals-interface": { - "type": "object", - "description": "Extension attribute for quote item totals model.", - "properties": { - "cost": { - "type": "number", - "description": "Cost for quote item." - }, - "catalog_price": { - "type": "number", - "description": "Catalog price for quote item." - }, - "base_catalog_price": { - "type": "number", - "description": "Catalog price for quote item in base currency." - }, - "catalog_price_incl_tax": { - "type": "number", - "description": "Catalog price with included tax for quote item." - }, - "base_catalog_price_incl_tax": { - "type": "number", - "description": "Catalog price with included tax for quote item in base currency." - }, - "cart_price": { - "type": "number", - "description": "Cart price for quote item." - }, - "base_cart_price": { - "type": "number", - "description": "Cart price for quote item in base currency." - }, - "cart_tax": { - "type": "number", - "description": "Tax from catalog price for quote item." - }, - "base_cart_tax": { - "type": "number", - "description": "Tax from catalog price for quote item in base currency." - }, - "cart_price_incl_tax": { - "type": "number", - "description": "Cart price with included tax for quote item." - }, - "base_cart_price_incl_tax": { - "type": "number", - "description": "Cart price with included tax for quote item in base currency." - }, - "extension_attributes": { - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface" - } - }, - "required": [ - "cost", - "catalog_price", - "base_catalog_price", - "catalog_price_incl_tax", - "base_catalog_price_incl_tax", - "cart_price", - "base_cart_price", - "cart_tax", - "base_cart_tax", - "cart_price_incl_tax", - "base_cart_price_incl_tax" - ] - }, - "negotiable-quote-data-negotiable-quote-item-totals-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteItemTotalsInterface" - }, - "quote-data-total-segment-interface": { - "type": "object", - "description": "Interface TotalsInterface", - "properties": { - "code": { - "type": "string", - "description": "Code" - }, - "title": { - "type": "string", - "description": "Total title" - }, - "value": { - "type": "number", - "description": "Total value" - }, - "area": { - "type": "string", - "description": "Display area code." - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-total-segment-extension-interface" - } - }, - "required": [ - "code", - "value" - ] - }, - "quote-data-total-segment-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface", - "properties": { - "tax_grandtotal_details": { - "type": "array", - "items": { - "$ref": "#/definitions/tax-data-grand-total-details-interface" - } - }, - "gift_cards": { - "type": "string" - }, - "gw_order_id": { - "type": "string" - }, - "gw_item_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "gw_allow_gift_receipt": { - "type": "string" - }, - "gw_add_card": { - "type": "string" - }, - "gw_price": { - "type": "string" - }, - "gw_base_price": { - "type": "string" - }, - "gw_items_price": { - "type": "string" - }, - "gw_items_base_price": { - "type": "string" - }, - "gw_card_price": { - "type": "string" - }, - "gw_card_base_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_price_incl_tax": { - "type": "string" - }, - "gw_base_price_incl_tax": { - "type": "string" - }, - "gw_card_price_incl_tax": { - "type": "string" - }, - "gw_card_base_price_incl_tax": { - "type": "string" - }, - "gw_items_price_incl_tax": { - "type": "string" - }, - "gw_items_base_price_incl_tax": { - "type": "string" - }, - "vertex_tax_calculation_messages": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "tax-data-grand-total-details-interface": { - "type": "object", - "description": "Interface GrandTotalDetailsInterface", - "properties": { - "amount": { - "type": "number", - "description": "Tax amount value" - }, - "rates": { - "type": "array", - "description": "Tax rates info", - "items": { - "$ref": "#/definitions/tax-data-grand-total-rates-interface" - } - }, - "group_id": { - "type": "integer", - "description": "Group identifier" - } - }, - "required": [ - "amount", - "rates", - "group_id" - ] - }, - "tax-data-grand-total-rates-interface": { - "type": "object", - "description": "Interface GrandTotalRatesInterface", - "properties": { - "percent": { - "type": "string", - "description": "Tax percentage value" - }, - "title": { - "type": "string", - "description": "Rate title" - } - }, - "required": [ - "percent", - "title" - ] - }, - "quote-data-totals-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface", - "properties": { - "coupon_label": { - "type": "string" - }, - "base_customer_balance_amount": { - "type": "number" - }, - "customer_balance_amount": { - "type": "number" - }, - "negotiable_quote_totals": { - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface" - }, - "reward_points_balance": { - "type": "number" - }, - "reward_currency_amount": { - "type": "number" - }, - "base_reward_currency_amount": { - "type": "number" - } - } - }, - "negotiable-quote-data-negotiable-quote-totals-interface": { - "type": "object", - "description": "Extension attribute for quote totals model.", - "properties": { - "items_count": { - "type": "integer", - "description": "The number of different items or products in the cart." - }, - "quote_status": { - "type": "string", - "description": "Negotiable quote status." - }, - "created_at": { - "type": "string", - "description": "The cart creation date and time." - }, - "updated_at": { - "type": "string", - "description": "The cart last update date and time." - }, - "customer_group": { - "type": "integer", - "description": "Customer group id." - }, - "base_to_quote_rate": { - "type": "number", - "description": "Base currency to quote currency rate." - }, - "cost_total": { - "type": "number", - "description": "Total cost for quote." - }, - "base_cost_total": { - "type": "number", - "description": "Total cost for quote in base currency." - }, - "original_total": { - "type": "number", - "description": "Original quote total." - }, - "base_original_total": { - "type": "number", - "description": "Original quote total in base currency." - }, - "original_tax": { - "type": "number", - "description": "Original tax amount for quote." - }, - "base_original_tax": { - "type": "number", - "description": "Original tax amount for quote in base currency." - }, - "original_price_incl_tax": { - "type": "number", - "description": "Original price with included tax for quote." - }, - "base_original_price_incl_tax": { - "type": "number", - "description": "Original price with included tax for quote in base currency." - }, - "negotiated_price_type": { - "type": "integer", - "description": "Negotiable quote type." - }, - "negotiated_price_value": { - "type": "number", - "description": "Negotiable price value for quote." - } - }, - "required": [ - "items_count", - "quote_status", - "created_at", - "updated_at", - "customer_group", - "base_to_quote_rate", - "cost_total", - "base_cost_total", - "original_total", - "base_original_total", - "original_tax", - "base_original_tax", - "original_price_incl_tax", - "base_original_price_incl_tax", - "negotiated_price_type", - "negotiated_price_value" - ] - }, - "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" - } - } - }, - "bundle-data-option-type-interface": { - "type": "object", - "description": "Interface OptionTypeInterface", - "properties": { - "label": { - "type": "string", - "description": "Type label" - }, - "code": { - "type": "string", - "description": "Type code" - }, - "extension_attributes": { - "$ref": "#/definitions/bundle-data-option-type-extension-interface" - } - }, - "required": [ - "label", - "code" - ] - }, - "bundle-data-option-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface" - }, - "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": "string", - "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" - }, - "framework-search-search-result-interface": { - "type": "object", - "description": "Interface SearchResultInterface", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-search-document-interface" - } - }, - "aggregations": { - "$ref": "#/definitions/framework-search-aggregation-interface" - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "aggregations", - "search_criteria", - "total_count" - ] - }, - "framework-search-document-interface": { - "type": "object", - "description": "Interface \\Magento\\Framework\\Api\\Search\\DocumentInterface", - "properties": { - "id": { - "type": "integer" - }, - "custom_attributes": { - "type": "array", - "description": "Custom attributes values.", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - }, - "required": [ - "id" - ] - }, - "framework-search-aggregation-interface": { - "type": "object", - "description": "Faceted data", - "properties": { - "buckets": { - "type": "array", - "description": "All Document fields", - "items": { - "$ref": "#/definitions/framework-search-bucket-interface" - } - }, - "bucket_names": { - "type": "array", - "description": "Document field names", - "items": { - "type": "string" - } - } - }, - "required": [ - "buckets", - "bucket_names" - ] - }, - "framework-search-bucket-interface": { - "type": "object", - "description": "Facet Bucket", - "properties": { - "name": { - "type": "string", - "description": "Field name" - }, - "values": { - "type": "array", - "description": "Field values", - "items": { - "$ref": "#/definitions/framework-search-aggregation-value-interface" - } - } - }, - "required": [ - "name", - "values" - ] - }, - "framework-search-aggregation-value-interface": { - "type": "object", - "description": "Interface \\Magento\\Framework\\Api\\Search\\AggregationValueInterface", - "properties": { - "value": { - "type": "string", - "description": "Aggregation" - }, - "metrics": { - "type": "array", - "description": "Metrics", - "items": { - "type": "string" - } - } - }, - "required": [ - "value", - "metrics" - ] - }, - "framework-search-search-criteria-interface": { - "type": "object", - "description": "Interface SearchCriteriaInterface", - "properties": { - "request_name": { - "type": "string" - }, - "filter_groups": { - "type": "array", - "description": "A list of filter groups.", - "items": { - "$ref": "#/definitions/framework-search-filter-group" - } - }, - "sort_orders": { - "type": "array", - "description": "Sort order.", - "items": { - "$ref": "#/definitions/framework-sort-order" - } - }, - "page_size": { - "type": "integer", - "description": "Page size." - }, - "current_page": { - "type": "integer", - "description": "Current page." - } - }, - "required": [ - "request_name", - "filter_groups" - ] - }, - "catalog-inventory-data-stock-item-collection-interface": { - "type": "object", - "description": "Interface StockItemCollectionInterface", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/catalog-inventory-stock-item-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-inventory-stock-item-criteria-interface": { - "type": "object", - "description": "Interface StockItemCriteriaInterface", - "properties": { - "mapper_interface_name": { - "type": "string", - "description": "Associated Mapper Interface name" - }, - "criteria_list": { - "type": "array", - "description": "Criteria objects added to current Composite Criteria", - "items": { - "$ref": "#/definitions/framework-criteria-interface" - } - }, - "filters": { - "type": "array", - "description": "List of filters", - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Ordering criteria", - "items": { - "type": "string" - } - }, - "limit": { - "type": "array", - "description": "Limit", - "items": { - "type": "string" - } - } - }, - "required": [ - "mapper_interface_name", - "criteria_list", - "filters", - "orders", - "limit" - ] - }, - "framework-criteria-interface": { - "type": "object", - "description": "Interface CriteriaInterface", - "properties": { - "mapper_interface_name": { - "type": "string", - "description": "Associated Mapper Interface name" - }, - "criteria_list": { - "type": "array", - "description": "Criteria objects added to current Composite Criteria", - "items": { - "$ref": "#/definitions/framework-criteria-interface" - } - }, - "filters": { - "type": "array", - "description": "List of filters", - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Ordering criteria", - "items": { - "type": "string" - } - }, - "limit": { - "type": "array", - "description": "Limit", - "items": { - "type": "string" - } - } - }, - "required": [ - "mapper_interface_name", - "criteria_list", - "filters", - "orders", - "limit" - ] - }, - "catalog-inventory-data-stock-status-interface": { - "type": "object", - "description": "Interface StockStatusInterface", - "properties": { - "product_id": { - "type": "integer" - }, - "stock_id": { - "type": "integer" - }, - "qty": { - "type": "integer" - }, - "stock_status": { - "type": "integer" - }, - "stock_item": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-inventory-data-stock-status-extension-interface" - } - }, - "required": [ - "product_id", - "stock_id", - "qty", - "stock_status", - "stock_item" - ] - }, - "catalog-inventory-data-stock-status-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface" - }, - "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", - "properties": { - "checkout_fields": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - } - }, - "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": { - "type": "string" - } - } - }, - "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", - "properties": { - "ext_order_id": { - "type": "string" - }, - "shipping_experience": { - "$ref": "#/definitions/temando-shipping-data-order-shipping-experience-interface" - }, - "collection_point": { - "$ref": "#/definitions/temando-shipping-data-collection-point-order-collection-point-interface" - } - } - }, - "temando-shipping-data-order-shipping-experience-interface": { - "type": "object", - "description": "Temando Shipping Experience Interface Local representation of a shipping rate in checkout. A set of shipping experiences is the result of creating an order at the Temando platform. (!) Needs to reside in Api namespace because selected shipping experience is exposed to public as a ShippingInterface extension attribute.", - "properties": { - "label": { - "type": "string" - }, - "code": { - "type": "string" - }, - "cost": { - "type": "number" - } - }, - "required": [ - "label", - "code", - "cost" - ] - }, - "temando-shipping-data-collection-point-order-collection-point-interface": { - "type": "object", - "description": "Temando Order Collection Point Interface – Order Details/Fulfillment", - "properties": { - "recipient_address_id": { - "type": "integer" - }, - "collection_point_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "country": { - "type": "string" - }, - "region": { - "type": "string" - }, - "postcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "street": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "recipient_address_id", - "collection_point_id", - "name", - "country", - "region", - "postcode", - "city", - "street" - ] - }, - "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" - ] - }, - "sales-data-order-search-result-interface": { - "type": "object", - "description": "Order search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-order-status-history-search-result-interface": { - "type": "object", - "description": "Order status history search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-order-status-history-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-order-item-search-result-interface": { - "type": "object", - "description": "Order item search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-order-item-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-invoice-search-result-interface": { - "type": "object", - "description": "Invoice search result interface. An invoice is a record of the receipt of payment for an order.", - "properties": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-invoice-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-invoice-comment-search-result-interface": { - "type": "object", - "description": "Invoice comment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-invoice-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-comment-search-result-interface": { - "type": "object", - "description": "Credit memo comment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-creditmemo-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-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-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-creditmemo-search-result-interface": { - "type": "object", - "description": "Credit memo search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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": { - "ext_shipment_id": { - "type": "string" - }, - "ext_return_shipment_id": { - "type": "string" - }, - "ext_location_id": { - "type": "string" - }, - "ext_tracking_url": { - "type": "string" - }, - "ext_tracking_reference": { - "type": "string" - } - } - }, - "sales-data-shipment-search-result-interface": { - "type": "object", - "description": "Shipment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-shipment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-shipment-comment-search-result-interface": { - "type": "object", - "description": "Shipment comment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-shipment-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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": { - "shipping_label": { - "type": "string" - }, - "ext_shipment_id": { - "type": "string" - }, - "ext_return_shipment_id": { - "type": "string" - }, - "ext_location_id": { - "type": "string" - }, - "ext_tracking_url": { - "type": "string" - }, - "ext_tracking_reference": { - "type": "string" - } - } - }, - "sales-data-transaction-interface": { - "type": "object", - "description": "Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.", - "properties": { - "transaction_id": { - "type": "integer", - "description": "Transaction ID." - }, - "parent_id": { - "type": "integer", - "description": "The parent ID for the transaction. Otherwise, null." - }, - "order_id": { - "type": "integer", - "description": "Order ID." - }, - "payment_id": { - "type": "integer", - "description": "Payment ID." - }, - "txn_id": { - "type": "string", - "description": "Transaction business ID." - }, - "parent_txn_id": { - "type": "string", - "description": "Parent transaction business ID." - }, - "txn_type": { - "type": "string", - "description": "Transaction type." - }, - "is_closed": { - "type": "integer", - "description": "Is-closed flag value." - }, - "additional_information": { - "type": "array", - "description": "Array of additional information. Otherwise, null.", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "description": "Created-at timestamp." - }, - "child_transactions": { - "type": "array", - "description": "Array of child transactions.", - "items": { - "$ref": "#/definitions/sales-data-transaction-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/sales-data-transaction-extension-interface" - } - }, - "required": [ - "transaction_id", - "order_id", - "payment_id", - "txn_id", - "parent_txn_id", - "txn_type", - "is_closed", - "created_at", - "child_transactions" - ] - }, - "sales-data-transaction-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface" - }, - "sales-data-transaction-search-result-interface": { - "type": "object", - "description": "Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.", - "properties": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-transaction-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "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-payment-details-interface": { - "type": "object", - "description": "Interface PaymentDetailsInterface", - "properties": { - "payment_methods": { - "type": "array", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - }, - "totals": { - "$ref": "#/definitions/quote-data-totals-interface" - }, - "extension_attributes": { - "$ref": "#/definitions/checkout-data-payment-details-extension-interface" - } - }, - "required": [ - "payment_methods", - "totals" - ] - }, - "checkout-data-payment-details-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface" - }, - "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-rule-search-result-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Rules.", - "items": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "sales-rule-data-coupon-search-result-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Rules.", - "items": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "sales-rule-data-coupon-mass-delete-result-interface": { - "type": "object", - "description": "Coupon mass delete results interface.", - "properties": { - "failed_items": { - "type": "array", - "description": "List of failed items.", - "items": { - "type": "string" - } - }, - "missing_items": { - "type": "array", - "description": "List of missing items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "failed_items", - "missing_items" - ] - }, - "checkout-agreements-data-agreement-interface": { - "type": "object", - "description": "Interface AgreementInterface", - "properties": { - "agreement_id": { - "type": "integer", - "description": "Agreement ID." - }, - "name": { - "type": "string", - "description": "Agreement name." - }, - "content": { - "type": "string", - "description": "Agreement content." - }, - "content_height": { - "type": "string", - "description": "Agreement content height. Otherwise, null." - }, - "checkbox_text": { - "type": "string", - "description": "Agreement checkbox text." - }, - "is_active": { - "type": "boolean", - "description": "Agreement status." - }, - "is_html": { - "type": "boolean", - "description": "* true - HTML. * false - plain text." - }, - "mode": { - "type": "integer", - "description": "The agreement applied mode." - }, - "extension_attributes": { - "$ref": "#/definitions/checkout-agreements-data-agreement-extension-interface" - } - }, - "required": [ - "agreement_id", - "name", - "content", - "checkbox_text", - "is_active", - "is_html", - "mode" - ] - }, - "checkout-agreements-data-agreement-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface" - }, - "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-rate-search-results-interface": { - "type": "object", - "description": "Interface for tax rate search results.", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-rule-search-results-interface": { - "type": "object", - "description": "Interface for tax rule search results.", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "tax-data-tax-class-search-results-interface": { - "type": "object", - "description": "Interface for tax class search results.", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/tax-data-tax-class-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "company-data-company-search-results-interface": { - "type": "object", - "description": "Interface for company search results", - "properties": { - "items": { - "type": "array", - "description": "Companies list", - "items": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-search-results-interface": { - "type": "object", - "description": "Interface for company team search results", - "properties": { - "items": { - "type": "array", - "description": "Teams list", - "items": { - "$ref": "#/definitions/company-data-team-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-hierarchy-interface": { - "type": "object", - "description": "Company hierarchy DTO interface for WebAPI.", - "properties": { - "structure_id": { - "type": "integer", - "description": "Structure ID." - }, - "entity_id": { - "type": "integer", - "description": "Entity ID." - }, - "entity_type": { - "type": "string", - "description": "Entity type." - }, - "structure_parent_id": { - "type": "integer", - "description": "Structure parent ID." - }, - "extension_attributes": { - "$ref": "#/definitions/company-data-hierarchy-extension-interface" - } - } - }, - "company-data-hierarchy-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\HierarchyInterface" - }, - "company-data-role-search-results-interface": { - "type": "object", - "description": "Interface for role search results.", - "properties": { - "items": { - "type": "array", - "description": "Roles list.", - "items": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "analytics-data-link-interface": { - "type": "object", - "description": "Interface LinkInterface Represents link with collected data and initialized vector for decryption.", - "properties": { - "url": { - "type": "string" - }, - "initialization_vector": { - "type": "string" - } - }, - "required": [ - "url", - "initialization_vector" - ] - }, - "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" - }, - "negotiable-quote-data-comment-interface": { - "type": "object", - "description": "Interface CommentInterface", - "properties": { - "entity_id": { - "type": "integer", - "description": "Comment ID." - }, - "parent_id": { - "type": "integer", - "description": "Negotiable quote ID, that this comment belongs to." - }, - "creator_type": { - "type": "integer", - "description": "The comment creator type." - }, - "is_decline": { - "type": "integer", - "description": "Is quote was declined by seller." - }, - "is_draft": { - "type": "integer", - "description": "Is quote draft flag." - }, - "creator_id": { - "type": "integer", - "description": "Comment creator ID." - }, - "comment": { - "type": "string", - "description": "Comment." - }, - "created_at": { - "type": "string", - "description": "Comment created at." - }, - "extension_attributes": { - "$ref": "#/definitions/negotiable-quote-data-comment-extension-interface" - }, - "attachments": { - "type": "array", - "description": "Existing attachments.", - "items": { - "$ref": "#/definitions/negotiable-quote-data-comment-attachment-interface" - } - } - }, - "required": [ - "entity_id", - "parent_id", - "creator_type", - "is_decline", - "is_draft", - "creator_id", - "comment", - "created_at", - "attachments" - ] - }, - "negotiable-quote-data-comment-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentInterface" - }, - "negotiable-quote-data-comment-attachment-interface": { - "type": "object", - "description": "Interface for quote comment attachment.", - "properties": { - "attachment_id": { - "type": "integer", - "description": "Attachment ID." - }, - "comment_id": { - "type": "integer", - "description": "Comment ID." - }, - "file_name": { - "type": "string", - "description": "File name." - }, - "file_path": { - "type": "string", - "description": "File path." - }, - "file_type": { - "type": "string", - "description": "File type." - }, - "extension_attributes": { - "$ref": "#/definitions/negotiable-quote-data-comment-attachment-extension-interface" - } - }, - "required": [ - "attachment_id", - "comment_id", - "file_name", - "file_path", - "file_type" - ] - }, - "negotiable-quote-data-comment-attachment-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentAttachmentInterface" - }, - "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", - "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" - }, - "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 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" - ] - }, - "shared-catalog-data-search-results-interface": { - "type": "object", - "description": "Interface for Shared Catalog search results.", - "properties": { - "items": { - "type": "array", - "description": "Shared Catalog list.", - "items": { - "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "gift-wrapping-data-wrapping-search-results-interface": { - "type": "object", - "description": "Interface WrappingSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-track-search-result-interface": { - "type": "object", - "description": "Interface TrackSearchResultInterface", - "properties": { - "items": { - "type": "array", - "description": "Rma list", - "items": { - "$ref": "#/definitions/rma-data-track-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "rma-data-comment-search-result-interface": { - "type": "object", - "description": "Interface CommentSearchResultInterface", - "properties": { - "items": { - "type": "array", - "description": "Rma Status History list", - "items": { - "$ref": "#/definitions/rma-data-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "rma-data-rma-search-result-interface": { - "type": "object", - "description": "Interface RmaSearchResultInterface", - "properties": { - "items": { - "type": "array", - "description": "Rma list", - "items": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "framework-metadata-object-interface": { - "type": "object", - "description": "Provides metadata about an attribute.", - "properties": { - "attribute_code": { - "type": "string", - "description": "Code of the attribute." - } - }, - "required": [ - "attribute_code" - ] - }, - "company-credit-data-credit-limit-search-results-interface": { - "type": "object", - "description": "Interface for Credit Limit search results.", - "properties": { - "items": { - "type": "array", - "description": "Credit Limit list.", - "items": { - "$ref": "#/definitions/company-credit-data-credit-data-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "company-credit-data-credit-data-interface": { - "type": "object", - "description": "Credit Data 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." - } - }, - "required": [ - "exceed_limit" - ] - }, - "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" - ] - }, - "company-credit-data-history-search-results-interface": { - "type": "object", - "description": "Interface for History search results.", - "properties": { - "items": { - "type": "array", - "description": "History list.", - "items": { - "$ref": "#/definitions/company-credit-data-history-data-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "company-credit-data-history-data-interface": { - "type": "object", - "description": "History data transfer object interface.", - "properties": { - "id": { - "type": "integer", - "description": "ID." - }, - "company_credit_id": { - "type": "integer", - "description": "Company credit id." - }, - "user_id": { - "type": "integer", - "description": "User Id." - }, - "user_type": { - "type": "integer", - "description": "User type: integration, admin, customer." - }, - "currency_credit": { - "type": "string", - "description": "Currency code of credit." - }, - "currency_operation": { - "type": "string", - "description": "Currency code of operation." - }, - "rate": { - "type": "number", - "description": "Currency rate between credit and operation currencies." - }, - "rate_credit": { - "type": "number", - "description": "Rate between credit and base currencies." - }, - "amount": { - "type": "number", - "description": "Amount." - }, - "balance": { - "type": "number", - "description": "Outstanding balance." - }, - "credit_limit": { - "type": "number", - "description": "Credit limit." - }, - "available_limit": { - "type": "number", - "description": "Available limit." - }, - "type": { - "type": "integer", - "description": "Type of operation." - }, - "datetime": { - "type": "string", - "description": "Operation datetime." - }, - "purchase_order": { - "type": "string", - "description": "Purchase Order number." - }, - "comment": { - "type": "string", - "description": "Comment." - } - }, - "required": [ - "rate", - "amount", - "balance", - "credit_limit" - ] - }, - "asynchronous-operations-data-detailed-bulk-operations-status-interface": { - "type": "object", - "description": "Interface BulkStatusInterface Bulk summary data with list of operations items full data.", - "properties": { - "operations_list": { - "type": "array", - "description": "Operations list.", - "items": { - "$ref": "#/definitions/asynchronous-operations-data-detailed-operation-status-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface" - }, - "bulk_id": { - "type": "string", - "description": "Bulk uuid" - }, - "description": { - "type": "string", - "description": "Bulk description" - }, - "start_time": { - "type": "string", - "description": "Bulk scheduled time" - }, - "user_id": { - "type": "integer", - "description": "User id" - }, - "operation_count": { - "type": "integer", - "description": "Total number of operations scheduled in scope of this bulk" - } - }, - "required": [ - "operations_list", - "bulk_id", - "description", - "start_time", - "user_id", - "operation_count" - ] - }, - "asynchronous-operations-data-detailed-operation-status-interface": { - "type": "object", - "description": "", - "properties": { - "result_serialized_data": { - "type": "string", - "description": "Serialized Data" - }, - "extension_attributes": { - "$ref": "#/definitions/asynchronous-operations-data-operation-extension-interface" - }, - "id": { - "type": "integer", - "description": "Id" - }, - "bulk_uuid": { - "type": "string", - "description": "Bulk uuid" - }, - "topic_name": { - "type": "string", - "description": "Queue Topic" - }, - "serialized_data": { - "type": "string", - "description": "Data" - }, - "status": { - "type": "integer", - "description": "Operation status" - }, - "result_message": { - "type": "string", - "description": "Result message" - }, - "error_code": { - "type": "integer", - "description": "Error code" - } - }, - "required": [ - "result_serialized_data", - "id", - "bulk_uuid", - "topic_name", - "serialized_data", - "status", - "result_message", - "error_code" - ] - }, - "asynchronous-operations-data-operation-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\OperationInterface" - }, - "asynchronous-operations-data-bulk-summary-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\BulkSummaryInterface" - }, - "asynchronous-operations-data-bulk-operations-status-interface": { - "type": "object", - "description": "Interface BulkStatusInterface Bulk summary data with list of operations items summary data.", - "properties": { - "operations_list": { - "type": "array", - "description": "List of operation with statuses (short data).", - "items": { - "$ref": "#/definitions/asynchronous-operations-data-summary-operation-status-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface" - }, - "bulk_id": { - "type": "string", - "description": "Bulk uuid" - }, - "description": { - "type": "string", - "description": "Bulk description" - }, - "start_time": { - "type": "string", - "description": "Bulk scheduled time" - }, - "user_id": { - "type": "integer", - "description": "User id" - }, - "operation_count": { - "type": "integer", - "description": "Total number of operations scheduled in scope of this bulk" - } - }, - "required": [ - "operations_list", - "bulk_id", - "description", - "start_time", - "user_id", - "operation_count" - ] - }, - "asynchronous-operations-data-summary-operation-status-interface": { - "type": "object", - "description": "Getter Class OperationsStatusInterface Instead of OperationInterface this class don't provide all operation data and not responsive to set any data, just to get operation data without serialized_data and result_serialized_data", - "properties": { - "id": { - "type": "integer", - "description": "Id" - }, - "status": { - "type": "integer", - "description": "Operation status" - }, - "result_message": { - "type": "string", - "description": "Result message" - }, - "error_code": { - "type": "integer", - "description": "Error code" - } - }, - "required": [ - "id", - "status", - "result_message", - "error_code" - ] - }, - "temando-shipping-data-collection-point-search-request-interface": { - "type": "object", - "description": "Temando Collection Point Search Request Interface", - "properties": { - "shipping_address_id": { - "type": "integer" - }, - "country_id": { - "type": "string" - }, - "postcode": { - "type": "string" - }, - "pending": { - "type": "boolean" - } - }, - "required": [ - "shipping_address_id", - "country_id", - "postcode", - "pending" - ] - }, - "temando-shipping-data-collection-point-quote-collection-point-interface": { - "type": "object", - "description": "Temando Quote Collection Point Interface – Checkout/Quoting", - "properties": { - "entity_id": { - "type": "integer" - }, - "collection_point_id": { - "type": "string" - }, - "recipient_address_id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "country": { - "type": "string" - }, - "region": { - "type": "string" - }, - "postcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "street": { - "type": "array", - "items": { - "type": "string" - } - }, - "opening_hours": { - "type": "array", - "items": { - "type": "string" - } - }, - "shipping_experiences": { - "type": "array", - "items": { - "type": "string" - } - }, - "selected": { - "type": "boolean" - } - }, - "required": [ - "entity_id", - "collection_point_id", - "recipient_address_id", - "name", - "country", - "region", - "postcode", - "city", - "street", - "opening_hours", - "shipping_experiences", - "selected" - ] - } - } -} \ No newline at end of file diff --git a/src/swagger/schemas/2.2.2.schema.json b/src/swagger/schemas/2.2.2.schema.json deleted file mode 100644 index c2122c7a9a7..00000000000 --- a/src/swagger/schemas/2.2.2.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.2","title":"Magento Commerce for B2B 2.2"},"host":"b2b222.vg","basePath":"/index.php/rest/default","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerGroupConfigV1","description":"Interface for system configuration operations for customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogTierPriceStorageV1","description":"Tier prices storage."},{"name":"catalogBasePriceStorageV1","description":"Base prices storage."},{"name":"catalogCostStorageV1","description":"Product cost storage."},{"name":"catalogSpecialPriceStorageV1","description":"Special price storage presents efficient price API and is used to retrieve, update or delete special prices."},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogCategoryListV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":"Interface ProductWebsiteLinkRepositoryInterface"},{"name":"catalogProductRenderListV1","description":"Interface which provides product renders information for products"},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteGuestShipmentEstimationV1","description":"Interface GuestShipmentEstimationInterface"},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"requisitionListRequisitionListRepositoryV1","description":"Interface RequisitionListRepositoryInterface"},{"name":"searchV1","description":"Search API for all requests"},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesRefundInvoiceV1","description":"Interface RefundInvoiceInterface"},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesRefundOrderV1","description":"Interface RefundOrderInterface"},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesShipOrderV1","description":"Class ShipOrderInterface"},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"salesInvoiceOrderV1","description":"Class InvoiceOrderInterface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"companyCompanyRepositoryV1","description":"A repository interface for company entity that provides basic CRUD operations."},{"name":"companyTeamRepositoryV1","description":"Interface for basic CRUD operations for team entity."},{"name":"companyCompanyHierarchyV1","description":"Interface for working with company hierarchy."},{"name":"companyRoleRepositoryV1","description":"A repository interface for role entity that provides basic CRUD operations."},{"name":"companyAclV1","description":"Access control list interface."},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"},{"name":"analyticsLinkProviderV1","description":"Provides link to file with collected report data."},{"name":"customerBalanceBalanceManagementV1","description":"Customer balance(store credit) operations"},{"name":"negotiableQuoteNegotiableQuoteManagementV1","description":"Interface for managing quotes."},{"name":"negotiableQuoteNegotiableQuotePriceManagementV1","description":"Interface for updating quote prices in case price changes occur in system."},{"name":"negotiableQuoteAttachmentContentManagementV1","description":"Interface for retrieving the list of negotiable quotes attachments."},{"name":"negotiableQuoteCommentLocatorV1","description":"Interface for load quote comments with attachment."},{"name":"negotiableQuoteNegotiableQuoteShippingManagementV1","description":"Interface for add and update negotiable quote shipping method."},{"name":"negotiableQuotePaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"negotiableQuoteShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"negotiableQuoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"negotiableQuoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"negotiableQuoteNegotiableCartRepositoryV1","description":"Interface is intended to be used in webapi only. For other cases CartRepositoryInterface should be used."},{"name":"negotiableQuoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"negotiableQuoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"negotiableQuoteCouponManagementV1","description":"Coupon management service interface."},{"name":"negotiableQuoteGiftCardAccountManagementV1","description":"Interface GiftCardAccountManagementInterface"},{"name":"sharedCatalogSharedCatalogRepositoryV1","description":""},{"name":"sharedCatalogCompanyManagementV1","description":"Shared catalog companies actions."},{"name":"sharedCatalogProductManagementV1","description":"Shared catalog products actions."},{"name":"sharedCatalogCategoryManagementV1","description":"Shared catalog products actions."},{"name":"giftCardAccountGiftCardAccountManagementV1","description":"Interface GiftCardAccountManagementInterface"},{"name":"giftCardAccountGuestGiftCardAccountManagementV1","description":"Interface GuestGiftCardAccountManagementInterface"},{"name":"giftRegistryShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"giftRegistryGuestCartShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"},{"name":"giftWrappingWrappingRepositoryV1","description":"Interface WrappingRepositoryInterface"},{"name":"rewardRewardManagementV1","description":"Interface RewardManagementInterface"},{"name":"rmaTrackManagementV1","description":"Interface TrackManagementInterface"},{"name":"rmaRmaRepositoryV1","description":"Interface RmaRepositoryInterface"},{"name":"rmaCommentManagementV1","description":"Interface CommentRepositoryInterface"},{"name":"rmaRmaManagementV1","description":"Interface RmaManagementInterface"},{"name":"rmaRmaAttributesManagementV1","description":"Interface RmaAttributesManagementInterface"},{"name":"companyCreditCreditLimitRepositoryV1","description":"Interface for credit limit repository for CRUD operations."},{"name":"companyCreditCreditLimitManagementV1","description":"Credit Limit management interface."},{"name":"companyCreditCreditBalanceManagementV1","description":"Interface for management decrease and increase credit balance operations."},{"name":"companyCreditCreditHistoryManagementV1","description":"Update credit history log and retrieve history which match a specified criteria."},{"name":"worldpayGuestPaymentInformationManagementProxyV1","description":"Interface GuestPaymentInformationManagementProxyInterface"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{id}":{"put":{"tags":["customerCustomerGroupConfigV1"],"description":"Set system default customer group.","operationId":"customerCustomerGroupConfigV1SetDefaultCustomerGroupPut","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by Customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"customerId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by Customer ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by Customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/resetPassword":{"post":{"tags":["customerAccountManagementV1"],"description":"Reset customer password.","operationId":"customerAccountManagementV1ResetPasswordPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","resetToken","newPassword"],"properties":{"email":{"type":"string"},"resetToken":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","parameters":[{"name":"$body","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices-information":{"post":{"tags":["catalogTierPriceStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogTierPriceStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices":{"post":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices-delete":{"post":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/base-prices-information":{"post":{"tags":["catalogBasePriceStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogBasePriceStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-base-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/base-prices":{"post":{"tags":["catalogBasePriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-base-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost-information":{"post":{"tags":["catalogCostStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogCostStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-cost-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost":{"post":{"tags":["catalogCostStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-cost-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost-delete":{"post":{"tags":["catalogCostStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will return True if deleted."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price-information":{"post":{"tags":["catalogSpecialPriceStorageV1"],"description":"Return product's special price. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogSpecialPriceStorageV1GetPost","parameters":[{"name":"$body","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price":{"post":{"tags":["catalogSpecialPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price-delete":{"post":{"tags":["catalogSpecialPriceStorageV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/list":{"get":{"tags":["catalogCategoryListV1"],"description":"Get category list","operationId":"catalogCategoryListV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products-render-info":{"get":{"tags":["catalogProductRenderListV1"],"description":"Collect and retrieve the list of product render info This info contains raw prices and formated prices, product name, stock status, store_id, etc","operationId":"catalogProductRenderListV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."},{"name":"storeId","in":"query","type":"integer","required":true},{"name":"currencyCode","in":"query","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-render-search-results-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"put":{"tags":["quoteCartRepositoryV1"],"description":"Save quote","operationId":"quoteCartRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer if customer does not have a cart yet.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"new cart ID if customer did not have a cart or ID of the existing cart otherwise."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer if customer does not have a cart yet.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"new cart ID if customer did not have a cart or ID of the existing cart otherwise."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/items":{"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/requisition_lists":{"post":{"tags":["requisitionListRequisitionListRepositoryV1"],"description":"Save Requisition List","operationId":"requisitionListRequisitionListRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["requisitionList"],"properties":{"requisitionList":{"$ref":"#/definitions/requisition-list-data-requisition-list-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/requisition-list-data-requisition-list-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/create":{"put":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/":{"post":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"$body","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoice/{invoiceId}/refund":{"post":{"tags":["salesRefundInvoiceV1"],"description":"Create refund for invoice","operationId":"salesRefundInvoiceV1ExecutePost","parameters":[{"name":"invoiceId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/refund":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Prepare creditmemo to refund and save it.","operationId":"salesCreditmemoManagementV1RefundPost","parameters":[{"name":"$body","in":"body","schema":{"required":["creditmemo"],"properties":{"creditmemo":{"$ref":"#/definitions/sales-data-creditmemo-interface"},"offlineRequested":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/refund":{"post":{"tags":["salesRefundOrderV1"],"description":"Create offline refund for order","operationId":"salesRefundOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/ship":{"post":{"tags":["salesShipOrderV1"],"description":"Creates new Shipment for given Order.","operationId":"salesShipOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Id of created Shipment."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/invoice":{"post":{"tags":["salesInvoiceOrderV1"],"description":"","operationId":"salesInvoiceOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"$body","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"$body","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"$body","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Configurable product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/":{"get":{"tags":["companyCompanyRepositoryV1"],"description":"Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included.","operationId":"companyCompanyRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["companyCompanyRepositoryV1"],"description":"Create or update a company account.","operationId":"companyCompanyRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["company"],"properties":{"company":{"$ref":"#/definitions/company-data-company-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/{companyId}":{"get":{"tags":["companyCompanyRepositoryV1"],"description":"Returns company details.","operationId":"companyCompanyRepositoryV1GetGet","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyCompanyRepositoryV1"],"description":"Delete a company. Customers belonging to a company are not deleted with this request.","operationId":"companyCompanyRepositoryV1DeleteByIdDelete","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["companyCompanyRepositoryV1"],"description":"Create or update a company account.","operationId":"companyCompanyRepositoryV1SavePut","parameters":[{"name":"companyId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["company"],"properties":{"company":{"$ref":"#/definitions/company-data-company-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/":{"get":{"tags":["companyTeamRepositoryV1"],"description":"Returns the list of teams for the specified search criteria (team name or description).","operationId":"companyTeamRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-team-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/{teamId}":{"get":{"tags":["companyTeamRepositoryV1"],"description":"Returns data for a team in the company, by entity id.","operationId":"companyTeamRepositoryV1GetGet","parameters":[{"name":"teamId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-team-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyTeamRepositoryV1"],"description":"Delete a team from the company structure.","operationId":"companyTeamRepositoryV1DeleteByIdDelete","parameters":[{"name":"teamId","in":"path","type":"integer","required":true}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["companyTeamRepositoryV1"],"description":"Update a team in the company structure.","operationId":"companyTeamRepositoryV1SavePut","parameters":[{"name":"teamId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["team"],"properties":{"team":{"$ref":"#/definitions/company-data-team-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/{companyId}":{"post":{"tags":["companyTeamRepositoryV1"],"description":"Create a team in the company structure.","operationId":"companyTeamRepositoryV1CreatePost","parameters":[{"name":"companyId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["team"],"properties":{"team":{"$ref":"#/definitions/company-data-team-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/hierarchy/{id}":{"get":{"tags":["companyCompanyHierarchyV1"],"description":"Returns the list of teams and company users in the company structure.","operationId":"companyCompanyHierarchyV1GetCompanyHierarchyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/company-data-hierarchy-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/hierarchy/move/{id}":{"put":{"tags":["companyCompanyHierarchyV1"],"description":"Moves teams and users within the company structure.","operationId":"companyCompanyHierarchyV1MoveNodePut","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["newParentId"],"properties":{"newParentId":{"type":"integer"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/":{"get":{"tags":["companyRoleRepositoryV1"],"description":"Returns the list of roles and permissions for a specified company.","operationId":"companyRoleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["companyRoleRepositoryV1"],"description":"Create or update a role for a selected company.","operationId":"companyRoleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["role"],"properties":{"role":{"$ref":"#/definitions/company-data-role-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{roleId}":{"get":{"tags":["companyRoleRepositoryV1"],"description":"Returns the list of permissions for a specified role.","operationId":"companyRoleRepositoryV1GetGet","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyRoleRepositoryV1"],"description":"Delete a role.","operationId":"companyRoleRepositoryV1DeleteDelete","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{id}":{"put":{"tags":["companyRoleRepositoryV1"],"description":"Create or update a role for a selected company.","operationId":"companyRoleRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["role"],"properties":{"role":{"$ref":"#/definitions/company-data-role-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/assignRoles":{"put":{"tags":["companyAclV1"],"description":"Change a role for a company user.","operationId":"companyAclV1AssignRolesPut","parameters":[{"name":"$body","in":"body","schema":{"required":["userId","roles"],"properties":{"userId":{"type":"integer"},"roles":{"type":"array","items":{"$ref":"#/definitions/company-data-role-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{roleId}/users":{"get":{"tags":["companyAclV1"],"description":"View the list of company users assigned to a specified role.","operationId":"companyAclV1GetUsersByRoleIdGet","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-customer-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/analytics/link":{"get":{"tags":["analyticsLinkProviderV1"],"description":"","operationId":"analyticsLinkProviderV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/analytics-data-link-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/balance/apply":{"post":{"tags":["customerBalanceBalanceManagementV1"],"description":"Apply store credit","operationId":"customerBalanceBalanceManagementV1ApplyPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/request":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/submitToCustomer":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/decline":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["quoteId","reason"],"properties":{"quoteId":{"type":"integer"},"reason":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/pricesUpdated":{"post":{"tags":["negotiableQuoteNegotiableQuotePriceManagementV1"],"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","parameters":[{"name":"$body","in":"body","schema":{"required":["quoteIds"],"properties":{"quoteIds":{"type":"array","items":{"type":"integer"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/attachmentContent":{"get":{"tags":["negotiableQuoteAttachmentContentManagementV1"],"description":"Returns content for one or more files attached on the quote comment.","operationId":"negotiableQuoteAttachmentContentManagementV1GetGet","parameters":[{"name":"attachmentIds","in":"query","type":"array","items":{"type":"integer"},"required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/negotiable-quote-data-attachment-content-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}/comments":{"get":{"tags":["negotiableQuoteCommentLocatorV1"],"description":"Returns comments for a specified negotiable quote.","operationId":"negotiableQuoteCommentLocatorV1GetListForQuoteGet","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true,"description":"Negotiable Quote ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of quote comments.","items":{"$ref":"#/definitions/negotiable-quote-data-comment-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}/shippingMethod":{"put":{"tags":["negotiableQuoteNegotiableQuoteShippingManagementV1"],"description":"Updates the shipping method on a negotiable quote.","operationId":"negotiableQuoteNegotiableQuoteShippingManagementV1SetShippingMethodPut","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true,"description":"Negotiable Quote id"},{"name":"$body","in":"body","schema":{"required":["shippingMethod"],"properties":{"shippingMethod":{"type":"string","description":"The shipping method code."}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/payment-information":{"post":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Get payment information","operationId":"negotiableQuotePaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/set-payment-information":{"post":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/shipping-information":{"post":{"tags":["negotiableQuoteShippingInformationManagementV1"],"description":"","operationId":"negotiableQuoteShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["negotiableQuoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["negotiableQuoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}":{"put":{"tags":["negotiableQuoteNegotiableCartRepositoryV1"],"description":"Save quote","operationId":"negotiableQuoteNegotiableCartRepositoryV1SavePut","parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/billing-address":{"get":{"tags":["negotiableQuoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"negotiableQuoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["negotiableQuoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"negotiableQuoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/totals":{"get":{"tags":["negotiableQuoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"negotiableQuoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["negotiableQuoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"negotiableQuoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/coupons":{"delete":{"tags":["negotiableQuoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"negotiableQuoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/giftCards":{"post":{"tags":["negotiableQuoteGiftCardAccountManagementV1"],"description":"","operationId":"negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["negotiableQuoteGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"negotiableQuoteGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}":{"get":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Return the following properties for the selected shared catalog: ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.","operationId":"sharedCatalogSharedCatalogRepositoryV1GetGet","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Delete a shared catalog by ID.","operationId":"sharedCatalogSharedCatalogRepositoryV1DeleteByIdDelete","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog":{"post":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Create or update Shared Catalog service.","operationId":"sharedCatalogSharedCatalogRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["sharedCatalog"],"properties":{"sharedCatalog":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}":{"put":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Create or update Shared Catalog service.","operationId":"sharedCatalogSharedCatalogRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sharedCatalog"],"properties":{"sharedCatalog":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/":{"get":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Return the list of shared catalogs and basic properties for each catalog.","operationId":"sharedCatalogSharedCatalogRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/shared-catalog-data-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/companies":{"get":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Return the list of company IDs for the companies assigned to the selected catalog.","operationId":"sharedCatalogCompanyManagementV1GetCompaniesGet","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/assignCompanies":{"post":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Assign companies to a shared catalog.","operationId":"sharedCatalogCompanyManagementV1AssignCompaniesPost","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["companies"],"properties":{"companies":{"type":"array","items":{"$ref":"#/definitions/company-data-company-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/unassignCompanies":{"post":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Unassign companies from a shared catalog.","operationId":"sharedCatalogCompanyManagementV1UnassignCompaniesPost","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["companies"],"properties":{"companies":{"type":"array","items":{"$ref":"#/definitions/company-data-company-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/products":{"get":{"tags":["sharedCatalogProductManagementV1"],"description":"Return the list of product SKUs in the selected shared catalog.","operationId":"sharedCatalogProductManagementV1GetProductsGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/assignProducts":{"post":{"tags":["sharedCatalogProductManagementV1"],"description":"Add products into the shared catalog.","operationId":"sharedCatalogProductManagementV1AssignProductsPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/unassignProducts":{"post":{"tags":["sharedCatalogProductManagementV1"],"description":"Remove the specified products from the shared catalog.","operationId":"sharedCatalogProductManagementV1UnassignProductsPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["products"],"properties":{"products":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/categories":{"get":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Return the list of categories in the selected shared catalog.","operationId":"sharedCatalogCategoryManagementV1GetCategoriesGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"integer"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/assignCategories":{"post":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Add categories into the shared catalog.","operationId":"sharedCatalogCategoryManagementV1AssignCategoriesPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["categories"],"properties":{"categories":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/unassignCategories":{"post":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Remove the specified categories from the shared catalog.","operationId":"sharedCatalogCategoryManagementV1UnassignCategoriesPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["categories"],"properties":{"categories":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/giftCards":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Return GiftCard Account cards","operationId":"giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards":{"put":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards":{"post":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards":{"post":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/giftregistry/mine/estimate-shipping-methods":{"post":{"tags":["giftRegistryShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":{"post":{"tags":["giftRegistryGuestCartShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{id}":{"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return data object for specified wrapping ID and store.","operationId":"giftWrappingWrappingRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Delete gift wrapping","operationId":"giftWrappingWrappingRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings":{"post":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return list of gift wrapping data objects based on search criteria","operationId":"giftWrappingWrappingRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{wrappingId}":{"put":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePut","parameters":[{"name":"wrappingId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/reward/mine/use-reward":{"post":{"tags":["rewardRewardManagementV1"],"description":"Set reward points to quote","operationId":"rewardRewardManagementV1SetPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers":{"post":{"tags":["rmaTrackManagementV1"],"description":"Add track","operationId":"rmaTrackManagementV1AddTrackPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["track"],"properties":{"track":{"$ref":"#/definitions/rma-data-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaTrackManagementV1"],"description":"Get track list","operationId":"rmaTrackManagementV1GetTracksGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-track-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers/{trackId}":{"delete":{"tags":["rmaTrackManagementV1"],"description":"Remove track by id","operationId":"rmaTrackManagementV1RemoveTrackByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"trackId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/labels":{"get":{"tags":["rmaTrackManagementV1"],"description":"Get shipping label int the PDF format","operationId":"rmaTrackManagementV1GetShippingLabelPdfGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}":{"get":{"tags":["rmaRmaRepositoryV1"],"description":"Return data object for specified RMA id","operationId":"rmaRmaRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["rmaRmaRepositoryV1"],"description":"Delete RMA","operationId":"rmaRmaRepositoryV1DeleteDelete","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/comments":{"post":{"tags":["rmaCommentManagementV1"],"description":"Add comment","operationId":"rmaCommentManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/rma-data-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaCommentManagementV1"],"description":"Comments list","operationId":"rmaCommentManagementV1CommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns":{"post":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPost","parameters":[{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaRmaManagementV1"],"description":"Return list of rma data objects based on search criteria","operationId":"rmaRmaManagementV1SearchGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/{attributeCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/form/{formCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve all attributes filtered by form code","operationId":"rmaRmaAttributesManagementV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get all attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/custom":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get custom attribute metadata for the given Data object's attribute set","operationId":"rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataObjectClassName","in":"query","type":"string","description":"Data object class name","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/framework-metadata-object-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/":{"get":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Returns the list of credits for specified companies.","operationId":"companyCreditCreditLimitRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}":{"get":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Returns data on the credit limit for a specified credit limit ID.","operationId":"companyCreditCreditLimitRepositoryV1GetGet","parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"reload","in":"query","type":"boolean","description":"[optional]","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{id}":{"put":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Update the following company credit attributes: credit currency, credit limit and setting to exceed credit.","operationId":"companyCreditCreditLimitRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["creditLimit"],"properties":{"creditLimit":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/company/{companyId}":{"get":{"tags":["companyCreditCreditLimitManagementV1"],"description":"Returns data on the credit limit for a specified company.","operationId":"companyCreditCreditLimitManagementV1GetCreditByCompanyIdGet","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}/increaseBalance":{"post":{"tags":["companyCreditCreditBalanceManagementV1"],"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","parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}/decreaseBalance":{"post":{"tags":["companyCreditCreditBalanceManagementV1"],"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","parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/history":{"get":{"tags":["companyCreditCreditHistoryManagementV1"],"description":"Returns the credit history for one or more companies.","operationId":"companyCreditCreditHistoryManagementV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-history-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/history/{historyId}":{"put":{"tags":["companyCreditCreditHistoryManagementV1"],"description":"Update the PO Number and/or comment for a Reimburse transaction.","operationId":"companyCreditCreditHistoryManagementV1UpdatePut","parameters":[{"name":"historyId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"properties":{"purchaseOrder":{"type":"string","description":"[optional]"},"comment":{"type":"string","description":"[optional]"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/worldpay-guest-carts/{cartId}/payment-information":{"post":{"tags":["worldpayGuestPaymentInformationManagementProxyV1"],"description":"Proxy handler for guest place order","operationId":"worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"website_id":{"type":"integer"},"store_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","website_id","store_group_id"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"website_id":{"type":"integer"},"root_category_id":{"type":"integer"},"default_store_id":{"type":"integer"},"name":{"type":"string"},"code":{"type":"string","description":"Group code."},"extension_attributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","website_id","root_category_id","default_store_id","name","code"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"default_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","default_group_id"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"website_id":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"base_currency_code":{"type":"string","description":"Base currency code"},"default_display_currency_code":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weight_unit":{"type":"string","description":"The unit of weight"},"base_url":{"type":"string","description":"Base URL for the store"},"base_link_url":{"type":"string","description":"Base link URL for the store"},"base_static_url":{"type":"string","description":"Base static URL for the store"},"base_media_url":{"type":"string","description":"Base media URL for the store"},"secure_base_url":{"type":"string","description":"Secure base URL for the store"},"secure_base_link_url":{"type":"string","description":"Secure base link URL for the store"},"secure_base_static_url":{"type":"string","description":"Secure base static URL for the store"},"secure_base_media_url":{"type":"string","description":"Secure base media URL for the store"},"extension_attributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","website_id","locale","base_currency_code","default_display_currency_code","timezone","weight_unit","base_url","base_link_url","base_static_url","base_media_url","secure_base_url","secure_base_link_url","secure_base_static_url","secure_base_media_url"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"base_currency_code":{"type":"string","description":"The base currency code for the store."},"base_currency_symbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"default_display_currency_code":{"type":"string","description":"The default display currency code for the store."},"default_display_currency_symbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"available_currency_codes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchange_rates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["base_currency_code","base_currency_symbol","default_display_currency_code","default_display_currency_symbol","available_currency_codes","exchange_rates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currency_to":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extension_attributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currency_to","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"two_letter_abbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"three_letter_abbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"full_name_locale":{"type":"string","description":"The country full name (in store locale) for the store."},"full_name_english":{"type":"string","description":"The country full name (in English) for the store."},"available_regions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","two_letter_abbreviation","three_letter_abbreviation","full_name_locale","full_name_english"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extension_attributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"Interface AttributeSetSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["filter_groups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"condition_type":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"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-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontend_input":{"type":"string","description":"HTML for input element."},"input_filter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"store_label":{"type":"string","description":"Label of the store."},"validation_rules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multiline_count":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"data_model":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontend_class":{"type":"string","description":"Class which is used to display the attribute on frontend."},"user_defined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sort_order":{"type":"integer","description":"Attributes sort order."},"frontend_label":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backend_type":{"type":"string","description":"Backend type."},"is_used_in_grid":{"type":"boolean","description":"It is used in customer grid"},"is_visible_in_grid":{"type":"boolean","description":"It is visible in customer grid"},"is_filterable_in_grid":{"type":"boolean","description":"It is filterable in customer grid"},"is_searchable_in_grid":{"type":"boolean","description":"It is searchable in customer grid"},"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["frontend_input","input_filter","store_label","validation_rules","multiline_count","visible","required","data_model","options","frontend_class","user_defined","sort_order","frontend_label","note","system","backend_type","attribute_code"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"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"}}},"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"},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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"},"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-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"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"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"Interface AttributeGroupSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-price-update-result-interface":{"type":"object","description":"Interface returned in case of incorrect price passed to efficient price API.","properties":{"message":{"type":"string","description":"Error message, that contains description of error occurred during price update."},"parameters":{"type":"array","description":"Parameters, that could be displayed in error message placeholders.","items":{"type":"string"}},"extension_attributes":{"$ref":"#/definitions/catalog-data-price-update-result-extension-interface"}},"required":["message","parameters"]},"catalog-data-price-update-result-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface"},"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":"","properties":{"id":{"type":"integer"},"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"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"path":{"type":"string"},"available_sort_by":{"type":"array","items":{"type":"string"}},"include_in_menu":{"type":"boolean"},"extension_attributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"product_count":{"type":"integer","description":"Product count"},"children_data":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parent_id","name","is_active","position","level","product_count","children_data"]},"catalog-data-category-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Categories","items":{"$ref":"#/definitions/catalog-data-category-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"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"]},"catalog-data-product-render-search-results-interface":{"type":"object","description":"Dto that holds render information about products","properties":{"items":{"type":"array","description":"List of products rendered information","items":{"$ref":"#/definitions/catalog-data-product-render-interface"}}},"required":["items"]},"catalog-data-product-render-interface":{"type":"object","description":"Represents Data Object which holds enough information to render product This information is put into part as Add To Cart or Add to Compare Data or Price Data","properties":{"add_to_cart_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"add_to_compare_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"price_info":{"$ref":"#/definitions/catalog-data-product-render-price-info-interface"},"images":{"type":"array","description":"Enough information, that needed to render image on front","items":{"$ref":"#/definitions/catalog-data-product-render-image-interface"}},"url":{"type":"string","description":"Product url"},"id":{"type":"integer","description":"Product identifier"},"name":{"type":"string","description":"Product name"},"type":{"type":"string","description":"Product type. Such as bundle, grouped, simple, etc..."},"is_salable":{"type":"string","description":"Information about product saleability (In Stock)"},"store_id":{"type":"integer","description":"Information about current store id or requested store id"},"currency_code":{"type":"string","description":"Current or desired currency code to product"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-extension-interface"}},"required":["add_to_cart_button","add_to_compare_button","price_info","images","url","id","name","type","is_salable","store_id","currency_code","extension_attributes"]},"catalog-data-product-render-button-interface":{"type":"object","description":"Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend","properties":{"post_data":{"type":"string","description":"Post data"},"url":{"type":"string","description":"Url, needed to add product to cart"},"required_options":{"type":"boolean","description":"Flag whether a product has options or not"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-button-extension-interface"}},"required":["post_data","url","required_options"]},"catalog-data-product-render-button-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ButtonInterface"},"catalog-data-product-render-price-info-interface":{"type":"object","description":"Price interface.","properties":{"final_price":{"type":"number","description":"Final price"},"max_price":{"type":"number","description":"Max price of a product"},"max_regular_price":{"type":"number","description":"Max regular price"},"minimal_regular_price":{"type":"number","description":"Minimal regular price"},"special_price":{"type":"number","description":"Special price"},"minimal_price":{"type":"number"},"regular_price":{"type":"number","description":"Regular price"},"formatted_prices":{"$ref":"#/definitions/catalog-data-product-render-formatted-price-info-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-price-info-extension-interface"}},"required":["final_price","max_price","max_regular_price","minimal_regular_price","special_price","minimal_price","regular_price","formatted_prices"]},"catalog-data-product-render-formatted-price-info-interface":{"type":"object","description":"Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html","properties":{"final_price":{"type":"string","description":"Html with final price"},"max_price":{"type":"string","description":"Max price of a product"},"minimal_price":{"type":"string","description":"The minimal price of the product or variation"},"max_regular_price":{"type":"string","description":"Max regular price"},"minimal_regular_price":{"type":"string","description":"Minimal regular price"},"special_price":{"type":"string","description":"Special price"},"regular_price":{"type":"string","description":"Price - is price of product without discounts and special price with taxes and fixed product tax"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-formatted-price-info-extension-interface"}},"required":["final_price","max_price","minimal_price","max_regular_price","minimal_regular_price","special_price","regular_price"]},"catalog-data-product-render-formatted-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\FormattedPriceInfoInterface"},"catalog-data-product-render-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\PriceInfoInterface","properties":{"msrp":{"$ref":"#/definitions/msrp-data-product-render-msrp-price-info-interface"},"tax_adjustments":{"$ref":"#/definitions/catalog-data-product-render-price-info-interface"},"weee_attributes":{"type":"array","items":{"$ref":"#/definitions/weee-data-product-render-weee-adjustment-attribute-interface"}},"weee_adjustment":{"type":"string"}}},"msrp-data-product-render-msrp-price-info-interface":{"type":"object","description":"Price interface.","properties":{"msrp_price":{"type":"string"},"is_applicable":{"type":"string"},"is_shown_price_on_gesture":{"type":"string"},"msrp_message":{"type":"string"},"explanation_message":{"type":"string"},"extension_attributes":{"$ref":"#/definitions/msrp-data-product-render-msrp-price-info-extension-interface"}},"required":["msrp_price","is_applicable","is_shown_price_on_gesture","msrp_message","explanation_message"]},"msrp-data-product-render-msrp-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Msrp\\Api\\Data\\ProductRender\\MsrpPriceInfoInterface"},"weee-data-product-render-weee-adjustment-attribute-interface":{"type":"object","description":"List of all weee attributes, their amounts, etc.., that product has","properties":{"amount":{"type":"string","description":"Weee attribute amount"},"tax_amount":{"type":"string","description":"Tax which is calculated to fixed product tax attribute"},"tax_amount_incl_tax":{"type":"string","description":"Tax amount of weee attribute"},"amount_excl_tax":{"type":"string","description":"Product amount exclude tax"},"attribute_code":{"type":"string","description":"Weee attribute code"},"extension_attributes":{"$ref":"#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface"}},"required":["amount","tax_amount","tax_amount_incl_tax","amount_excl_tax","attribute_code","extension_attributes"]},"weee-data-product-render-weee-adjustment-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Weee\\Api\\Data\\ProductRender\\WeeeAdjustmentAttributeInterface"},"catalog-data-product-render-image-interface":{"type":"object","description":"Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view","properties":{"url":{"type":"string","description":"Image url"},"code":{"type":"string","description":"Image code"},"height":{"type":"number","description":"Image height"},"width":{"type":"number","description":"Image width in px"},"label":{"type":"string","description":"Image label"},"resized_width":{"type":"number","description":"Resize width"},"resized_height":{"type":"number","description":"Resize height"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-image-extension-interface"}},"required":["url","code","height","width","label","resized_width","resized_height"]},"catalog-data-product-render-image-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ImageInterface"},"catalog-data-product-render-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRenderInterface","properties":{"wishlist_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"review_html":{"type":"string"}}},"catalog-inventory-data-stock-status-collection-interface":{"type":"object","description":"Stock Status collection interface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"search_criteria":{"$ref":"#/definitions/catalog-inventory-stock-status-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"product_id":{"type":"integer"},"stock_id":{"type":"integer"},"qty":{"type":"integer"},"stock_status":{"type":"integer"},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["product_id","stock_id","qty","stock_status","stock_item"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"catalog-inventory-stock-status-criteria-interface":{"type":"object","description":"Interface StockStatusCriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extension_attributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"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":"integer","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"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface","properties":{"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-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":{"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"}}},"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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrier_code":{"type":"string","description":"Shipping carrier code."},"method_code":{"type":"string","description":"Shipping method code."},"carrier_title":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"method_title":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"base_amount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"error_message":{"type":"string","description":"Shipping Error message."},"price_excl_tax":{"type":"number","description":"Shipping price excl tax."},"price_incl_tax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrier_code","method_code","amount","base_amount","available","error_message","price_excl_tax","price_incl_tax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grand_total":{"type":"number","description":"Grand total in quote currency"},"base_grand_total":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"base_subtotal":{"type":"number","description":"Subtotal in base currency"},"discount_amount":{"type":"number","description":"Discount amount in quote currency"},"base_discount_amount":{"type":"number","description":"Discount amount in base currency"},"subtotal_with_discount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"base_subtotal_with_discount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shipping_amount":{"type":"number","description":"Shipping amount in quote currency"},"base_shipping_amount":{"type":"number","description":"Shipping amount in base currency"},"shipping_discount_amount":{"type":"number","description":"Shipping discount amount in quote currency"},"base_shipping_discount_amount":{"type":"number","description":"Shipping discount amount in base currency"},"tax_amount":{"type":"number","description":"Tax amount in quote currency"},"base_tax_amount":{"type":"number","description":"Tax amount in base currency"},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount in quote currency"},"base_shipping_tax_amount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in quote currency"},"base_subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in base currency"},"shipping_incl_tax":{"type":"number","description":"Shipping including tax in quote currency"},"base_shipping_incl_tax":{"type":"number","description":"Shipping including tax in base currency"},"base_currency_code":{"type":"string","description":"Base currency code"},"quote_currency_code":{"type":"string","description":"Quote currency code"},"coupon_code":{"type":"string","description":"Applied coupon code"},"items_qty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"total_segments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weee_tax_applied_amount","total_segments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"item_id":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"base_price":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"row_total":{"type":"number","description":"Row total in quote currency."},"base_row_total":{"type":"number","description":"Row total in base currency."},"row_total_with_discount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"tax_amount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"base_tax_amount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"tax_percent":{"type":"number","description":"Tax percent. Otherwise, null."},"discount_amount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"base_discount_amount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discount_percent":{"type":"number","description":"Discount percent. Otherwise, null."},"price_incl_tax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"base_price_incl_tax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"row_total_incl_tax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"base_row_total_incl_tax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weee_tax_applied":{"type":"string","description":"Item weee tax applied in quote currency."},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["item_id","price","base_price","qty","row_total","base_row_total","options","weee_tax_applied_amount","weee_tax_applied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface","properties":{"negotiable_quote_item_totals":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface"}}},"negotiable-quote-data-negotiable-quote-item-totals-interface":{"type":"object","description":"Extension attribute for quote item totals model.","properties":{"cost":{"type":"number","description":"Cost for quote item."},"catalog_price":{"type":"number","description":"Catalog price for quote item."},"base_catalog_price":{"type":"number","description":"Catalog price for quote item in base currency."},"catalog_price_incl_tax":{"type":"number","description":"Catalog price with included tax for quote item."},"base_catalog_price_incl_tax":{"type":"number","description":"Catalog price with included tax for quote item in base currency."},"cart_price":{"type":"number","description":"Cart price for quote item."},"base_cart_price":{"type":"number","description":"Cart price for quote item in base currency."},"cart_tax":{"type":"number","description":"Tax from catalog price for quote item."},"base_cart_tax":{"type":"number","description":"Tax from catalog price for quote item in base currency."},"cart_price_incl_tax":{"type":"number","description":"Cart price with included tax for quote item."},"base_cart_price_incl_tax":{"type":"number","description":"Cart price with included tax for quote item in base currency."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface"}},"required":["cost","catalog_price","base_catalog_price","catalog_price_incl_tax","base_catalog_price_incl_tax","cart_price","base_cart_price","cart_tax","base_cart_tax","cart_price_incl_tax","base_cart_price_incl_tax"]},"negotiable-quote-data-negotiable-quote-item-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteItemTotalsInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extension_attributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"tax_grandtotal_details":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}},"gift_cards":{"type":"string"},"gw_order_id":{"type":"string"},"gw_item_ids":{"type":"array","items":{"type":"string"}},"gw_allow_gift_receipt":{"type":"string"},"gw_add_card":{"type":"string"},"gw_price":{"type":"string"},"gw_base_price":{"type":"string"},"gw_items_price":{"type":"string"},"gw_items_base_price":{"type":"string"},"gw_card_price":{"type":"string"},"gw_card_base_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_price_incl_tax":{"type":"string"},"gw_base_price_incl_tax":{"type":"string"},"gw_card_price_incl_tax":{"type":"string"},"gw_card_base_price_incl_tax":{"type":"string"},"gw_items_price_incl_tax":{"type":"string"},"gw_items_base_price_incl_tax":{"type":"string"}}},"tax-data-grand-total-details-interface":{"type":"object","description":"Interface GrandTotalDetailsInterface","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"group_id":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","group_id"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"Interface GrandTotalRatesInterface","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface","properties":{"coupon_label":{"type":"string"},"base_customer_balance_amount":{"type":"number"},"customer_balance_amount":{"type":"number"},"negotiable_quote_totals":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-totals-interface"},"reward_points_balance":{"type":"number"},"reward_currency_amount":{"type":"number"},"base_reward_currency_amount":{"type":"number"}}},"negotiable-quote-data-negotiable-quote-totals-interface":{"type":"object","description":"Extension attribute for quote totals model.","properties":{"items_count":{"type":"integer","description":"The number of different items or products in the cart."},"quote_status":{"type":"string","description":"Negotiable quote status."},"created_at":{"type":"string","description":"The cart creation date and time."},"updated_at":{"type":"string","description":"The cart last update date and time."},"customer_group":{"type":"integer","description":"Customer group id."},"base_to_quote_rate":{"type":"number","description":"Base currency to quote currency rate."},"cost_total":{"type":"number","description":"Total cost for quote."},"base_cost_total":{"type":"number","description":"Total cost for quote in base currency."},"original_total":{"type":"number","description":"Original quote total."},"base_original_total":{"type":"number","description":"Original quote total in base currency."},"original_tax":{"type":"number","description":"Original tax amount for quote."},"base_original_tax":{"type":"number","description":"Original tax amount for quote in base currency."},"original_price_incl_tax":{"type":"number","description":"Original price with included tax for quote."},"base_original_price_incl_tax":{"type":"number","description":"Original price with included tax for quote in base currency."},"negotiated_price_type":{"type":"integer","description":"Negotiable quote type."},"negotiated_price_value":{"type":"number","description":"Negotiable price value for quote."}},"required":["items_count","quote_status","created_at","updated_at","customer_group","base_to_quote_rate","cost_total","base_cost_total","original_total","base_original_total","original_tax","base_original_tax","original_price_incl_tax","base_original_price_incl_tax","negotiated_price_type","negotiated_price_value"]},"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"},"framework-search-search-result-interface":{"type":"object","description":"Interface SearchResultInterface","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"search_criteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","aggregations","search_criteria","total_count"]},"framework-search-document-interface":{"type":"object","description":"Interface \\Magento\\Framework\\Api\\Search\\DocumentInterface","properties":{"id":{"type":"integer"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucket_names":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucket_names"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"Interface \\Magento\\Framework\\Api\\Search\\AggregationValueInterface","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"Interface SearchCriteriaInterface","properties":{"request_name":{"type":"string"},"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["request_name","filter_groups"]},"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"}}},"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"}},"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"}}},"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"},"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"]},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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"}}},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-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"},"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-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transaction_id":{"type":"integer","description":"Transaction ID."},"parent_id":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"order_id":{"type":"integer","description":"Order ID."},"payment_id":{"type":"integer","description":"Payment ID."},"txn_id":{"type":"string","description":"Transaction business ID."},"parent_txn_id":{"type":"string","description":"Parent transaction business ID."},"txn_type":{"type":"string","description":"Transaction type."},"is_closed":{"type":"integer","description":"Is-closed flag value."},"additional_information":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"created_at":{"type":"string","description":"Created-at timestamp."},"child_transactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transaction_id","order_id","payment_id","txn_id","parent_txn_id","txn_type","is_closed","created_at","child_transactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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-payment-details-interface":{"type":"object","description":"Interface PaymentDetailsInterface","properties":{"payment_methods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extension_attributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["payment_methods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"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-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failed_items":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missing_items":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failed_items","missing_items"]},"checkout-agreements-data-agreement-interface":{"type":"object","description":"Interface AgreementInterface","properties":{"agreement_id":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"content_height":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkbox_text":{"type":"string","description":"Agreement checkbox text."},"is_active":{"type":"boolean","description":"Agreement status."},"is_html":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extension_attributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreement_id","name","content","checkbox_text","is_active","is_html","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-data-company-search-results-interface":{"type":"object","description":"Interface for company search results","properties":{"items":{"type":"array","description":"Companies list","items":{"$ref":"#/definitions/company-data-company-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-search-results-interface":{"type":"object","description":"Interface for company team search results","properties":{"items":{"type":"array","description":"Teams list","items":{"$ref":"#/definitions/company-data-team-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-hierarchy-interface":{"type":"object","description":"Company hierarchy DTO interface for WebAPI.","properties":{"structure_id":{"type":"integer","description":"Structure ID."},"entity_id":{"type":"integer","description":"Entity ID."},"entity_type":{"type":"string","description":"Entity type."},"structure_parent_id":{"type":"integer","description":"Structure parent ID."},"extension_attributes":{"$ref":"#/definitions/company-data-hierarchy-extension-interface"}}},"company-data-hierarchy-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\HierarchyInterface"},"company-data-role-search-results-interface":{"type":"object","description":"Interface for role search results.","properties":{"items":{"type":"array","description":"Roles list.","items":{"$ref":"#/definitions/company-data-role-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"analytics-data-link-interface":{"type":"object","description":"Interface LinkInterface Represents link with collected data and initialized vector for decryption.","properties":{"url":{"type":"string"},"initialization_vector":{"type":"string"}},"required":["url","initialization_vector"]},"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"},"negotiable-quote-data-comment-interface":{"type":"object","description":"Interface CommentInterface","properties":{"entity_id":{"type":"integer","description":"Comment ID."},"parent_id":{"type":"integer","description":"Negotiable quote ID, that this comment belongs to."},"creator_type":{"type":"integer","description":"The comment creator type."},"is_decline":{"type":"integer","description":"Is quote was declined by seller."},"is_draft":{"type":"integer","description":"Is quote draft flag."},"creator_id":{"type":"integer","description":"Comment creator ID."},"comment":{"type":"string","description":"Comment."},"created_at":{"type":"string","description":"Comment created at."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-comment-extension-interface"},"attachments":{"type":"array","description":"Existing attachments.","items":{"$ref":"#/definitions/negotiable-quote-data-comment-attachment-interface"}}},"required":["entity_id","parent_id","creator_type","is_decline","is_draft","creator_id","comment","created_at","attachments"]},"negotiable-quote-data-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentInterface"},"negotiable-quote-data-comment-attachment-interface":{"type":"object","description":"Interface for quote comment attachment.","properties":{"attachment_id":{"type":"integer","description":"Attachment ID."},"comment_id":{"type":"integer","description":"Comment ID."},"file_name":{"type":"string","description":"File name."},"file_path":{"type":"string","description":"File path."},"file_type":{"type":"string","description":"File type."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-comment-attachment-extension-interface"}},"required":["attachment_id","comment_id","file_name","file_path","file_type"]},"negotiable-quote-data-comment-attachment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentAttachmentInterface"},"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","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"},"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 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"]},"shared-catalog-data-search-results-interface":{"type":"object","description":"Interface for Shared Catalog search results.","properties":{"items":{"type":"array","description":"Shared Catalog list.","items":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"gift-wrapping-data-wrapping-search-results-interface":{"type":"object","description":"Interface WrappingSearchResultsInterface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-track-search-result-interface":{"type":"object","description":"Interface TrackSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-track-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"rma-data-comment-search-result-interface":{"type":"object","description":"Interface CommentSearchResultInterface","properties":{"items":{"type":"array","description":"Rma Status History list","items":{"$ref":"#/definitions/rma-data-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"rma-data-rma-search-result-interface":{"type":"object","description":"Interface RmaSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-rma-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"framework-metadata-object-interface":{"type":"object","description":"Provides metadata about an attribute.","properties":{"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["attribute_code"]},"company-credit-data-credit-limit-search-results-interface":{"type":"object","description":"Interface for Credit Limit search results.","properties":{"items":{"type":"array","description":"Credit Limit list.","items":{"$ref":"#/definitions/company-credit-data-credit-data-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-credit-data-interface":{"type":"object","description":"Credit Data 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."}},"required":["exceed_limit"]},"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"]},"company-credit-data-history-search-results-interface":{"type":"object","description":"Interface for History search results.","properties":{"items":{"type":"array","description":"History list.","items":{"$ref":"#/definitions/company-credit-data-history-data-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-history-data-interface":{"type":"object","description":"History data transfer object interface.","properties":{"id":{"type":"integer","description":"ID."},"company_credit_id":{"type":"integer","description":"Company credit id."},"user_id":{"type":"integer","description":"User Id."},"user_type":{"type":"integer","description":"User type: integration, admin, customer."},"currency_credit":{"type":"string","description":"Currency code of credit."},"currency_operation":{"type":"string","description":"Currency code of operation."},"rate":{"type":"number","description":"Currency rate between credit and operation currencies."},"rate_credit":{"type":"number","description":"Rate between credit and base currencies."},"amount":{"type":"number","description":"Amount."},"balance":{"type":"number","description":"Outstanding balance."},"credit_limit":{"type":"number","description":"Credit limit."},"available_limit":{"type":"number","description":"Available limit."},"type":{"type":"integer","description":"Type of operation."},"datetime":{"type":"string","description":"Operation datetime."},"purchase_order":{"type":"string","description":"Purchase Order number."},"comment":{"type":"string","description":"Comment."}},"required":["rate","amount","balance","credit_limit"]}}} diff --git a/src/swagger/schemas/2.2.9.schema.json b/src/swagger/schemas/2.2.9.schema.json deleted file mode 100644 index 0e55fdf1169..00000000000 --- a/src/swagger/schemas/2.2.9.schema.json +++ /dev/null @@ -1,35451 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2.2", - "title": "Magento Commerce for B2B" - }, - "host": "magento2.vagrant2", - "basePath": "/rest/default", - "schemes": [ - "https" - ], - "tags": [ - { - "name": "storeStoreRepositoryV1", - "description": "Store repository interface" - }, - { - "name": "storeGroupRepositoryV1", - "description": "Group repository interface" - }, - { - "name": "storeWebsiteRepositoryV1", - "description": "Website repository interface" - }, - { - "name": "storeStoreConfigManagerV1", - "description": "Store config manager interface" - }, - { - "name": "directoryCurrencyInformationAcquirerV1", - "description": "Currency information acquirer interface" - }, - { - "name": "directoryCountryInformationAcquirerV1", - "description": "Country information acquirer interface" - }, - { - "name": "eavAttributeSetRepositoryV1", - "description": "Interface AttributeSetRepositoryInterface" - }, - { - "name": "eavAttributeSetManagementV1", - "description": "Interface AttributeSetManagementInterface" - }, - { - "name": "customerGroupRepositoryV1", - "description": "Customer group CRUD interface" - }, - { - "name": "customerGroupManagementV1", - "description": "Interface for managing customer groups." - }, - { - "name": "customerCustomerGroupConfigV1", - "description": "Interface for system configuration operations for customer groups." - }, - { - "name": "customerCustomerMetadataV1", - "description": "Interface for retrieval information about customer attributes metadata." - }, - { - "name": "customerAddressMetadataV1", - "description": "Interface for retrieval information about customer address attributes metadata." - }, - { - "name": "customerCustomerRepositoryV1", - "description": "Customer CRUD interface." - }, - { - "name": "customerAccountManagementV1", - "description": "Interface for managing customers accounts." - }, - { - "name": "customerAddressRepositoryV1", - "description": "Customer address CRUD interface." - }, - { - "name": "backendModuleServiceV1", - "description": "Interface for module service." - }, - { - "name": "cmsPageRepositoryV1", - "description": "CMS page CRUD interface." - }, - { - "name": "cmsBlockRepositoryV1", - "description": "CMS block CRUD interface." - }, - { - "name": "catalogProductRepositoryV1", - "description": "" - }, - { - "name": "catalogProductAttributeTypesListV1", - "description": "" - }, - { - "name": "catalogProductAttributeRepositoryV1", - "description": "Interface RepositoryInterface must be implemented in new model" - }, - { - "name": "catalogCategoryAttributeRepositoryV1", - "description": "Interface RepositoryInterface must be implemented in new model" - }, - { - "name": "catalogCategoryAttributeOptionManagementV1", - "description": "Interface RepositoryInterface must be implemented in new model" - }, - { - "name": "catalogProductTypeListV1", - "description": "" - }, - { - "name": "catalogAttributeSetRepositoryV1", - "description": "" - }, - { - "name": "catalogAttributeSetManagementV1", - "description": "" - }, - { - "name": "catalogProductAttributeManagementV1", - "description": "" - }, - { - "name": "catalogProductAttributeGroupRepositoryV1", - "description": "" - }, - { - "name": "catalogProductAttributeOptionManagementV1", - "description": "" - }, - { - "name": "catalogProductMediaAttributeManagementV1", - "description": "" - }, - { - "name": "catalogProductAttributeMediaGalleryManagementV1", - "description": "" - }, - { - "name": "catalogProductTierPriceManagementV1", - "description": "" - }, - { - "name": "catalogTierPriceStorageV1", - "description": "Tier prices storage." - }, - { - "name": "catalogBasePriceStorageV1", - "description": "Base prices storage." - }, - { - "name": "catalogCostStorageV1", - "description": "Product cost storage." - }, - { - "name": "catalogSpecialPriceStorageV1", - "description": "Special price storage presents efficient price API and is used to retrieve, update or delete special prices." - }, - { - "name": "catalogCategoryRepositoryV1", - "description": "" - }, - { - "name": "catalogCategoryManagementV1", - "description": "" - }, - { - "name": "catalogCategoryListV1", - "description": "" - }, - { - "name": "catalogProductCustomOptionTypeListV1", - "description": "" - }, - { - "name": "catalogProductCustomOptionRepositoryV1", - "description": "" - }, - { - "name": "catalogProductLinkTypeListV1", - "description": "" - }, - { - "name": "catalogProductLinkManagementV1", - "description": "" - }, - { - "name": "catalogProductLinkRepositoryV1", - "description": "Interface Product links handling interface" - }, - { - "name": "catalogCategoryLinkManagementV1", - "description": "" - }, - { - "name": "catalogCategoryLinkRepositoryV1", - "description": "" - }, - { - "name": "catalogProductWebsiteLinkRepositoryV1", - "description": "Interface ProductWebsiteLinkRepositoryInterface" - }, - { - "name": "catalogProductRenderListV1", - "description": "Interface which provides product renders information for products" - }, - { - "name": "quoteCartRepositoryV1", - "description": "Interface CartRepositoryInterface" - }, - { - "name": "quoteCartManagementV1", - "description": "Interface CartManagementInterface" - }, - { - "name": "quoteGuestCartRepositoryV1", - "description": "Cart Repository interface for guest carts." - }, - { - "name": "quoteGuestCartManagementV1", - "description": "Cart Management interface for guest carts." - }, - { - "name": "quoteShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "quoteShipmentEstimationV1", - "description": "Interface ShipmentManagementInterface" - }, - { - "name": "quoteGuestShippingMethodManagementV1", - "description": "Shipping method management interface for guest carts." - }, - { - "name": "quoteGuestShipmentEstimationV1", - "description": "Interface GuestShipmentEstimationInterface" - }, - { - "name": "quoteCartItemRepositoryV1", - "description": "Interface CartItemRepositoryInterface" - }, - { - "name": "quoteGuestCartItemRepositoryV1", - "description": "Cart Item repository interface for guest carts." - }, - { - "name": "quotePaymentMethodManagementV1", - "description": "Interface PaymentMethodManagementInterface" - }, - { - "name": "quoteGuestPaymentMethodManagementV1", - "description": "Payment method management interface for guest carts." - }, - { - "name": "quoteBillingAddressManagementV1", - "description": "Interface BillingAddressManagementInterface" - }, - { - "name": "quoteGuestBillingAddressManagementV1", - "description": "Billing address management interface for guest carts." - }, - { - "name": "quoteCouponManagementV1", - "description": "Coupon management service interface." - }, - { - "name": "quoteGuestCouponManagementV1", - "description": "Coupon management interface for guest carts." - }, - { - "name": "quoteCartTotalRepositoryV1", - "description": "Interface CartTotalRepositoryInterface" - }, - { - "name": "quoteGuestCartTotalManagementV1", - "description": "Bundled API to collect totals for cart based on shipping/payment methods and additional data." - }, - { - "name": "quoteGuestCartTotalRepositoryV1", - "description": "Cart totals repository interface for guest carts." - }, - { - "name": "quoteCartTotalManagementV1", - "description": "Bundled API to collect totals for cart based on shipping/payment methods and additional data." - }, - { - "name": "catalogInventoryStockRegistryV1", - "description": "Interface StockRegistryInterface" - }, - { - "name": "bundleProductLinkManagementV1", - "description": "Interface for Management of ProductLink" - }, - { - "name": "bundleProductOptionRepositoryV1", - "description": "Interface ProductOptionRepositoryInterface" - }, - { - "name": "bundleProductOptionTypeListV1", - "description": "Interface ProductOptionTypeListInterface" - }, - { - "name": "bundleProductOptionManagementV1", - "description": "Option manager for bundle products" - }, - { - "name": "requisitionListRequisitionListRepositoryV1", - "description": "Interface RequisitionListRepositoryInterface" - }, - { - "name": "searchV1", - "description": "Search API for all requests" - }, - { - "name": "salesOrderRepositoryV1", - "description": "Order repository 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." - }, - { - "name": "salesOrderManagementV1", - "description": "Order management 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." - }, - { - "name": "salesOrderAddressRepositoryV1", - "description": "Order address repository 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." - }, - { - "name": "salesOrderItemRepositoryV1", - "description": "Order item repository 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." - }, - { - "name": "salesInvoiceRepositoryV1", - "description": "Invoice repository interface. An invoice is a record of the receipt of payment for an order." - }, - { - "name": "salesInvoiceManagementV1", - "description": "Invoice management interface. An invoice is a record of the receipt of payment for an order." - }, - { - "name": "salesInvoiceCommentRepositoryV1", - "description": "Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history." - }, - { - "name": "salesRefundInvoiceV1", - "description": "Interface RefundInvoiceInterface" - }, - { - "name": "salesCreditmemoManagementV1", - "description": "Credit memo add 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." - }, - { - "name": "salesCreditmemoRepositoryV1", - "description": "Credit memo repository 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." - }, - { - "name": "salesCreditmemoCommentRepositoryV1", - "description": "Credit memo comment repository 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." - }, - { - "name": "salesRefundOrderV1", - "description": "Interface RefundOrderInterface" - }, - { - "name": "salesShipmentRepositoryV1", - "description": "Shipment repository 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." - }, - { - "name": "salesShipmentManagementV1", - "description": "Shipment management 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." - }, - { - "name": "salesShipmentCommentRepositoryV1", - "description": "Shipment comment repository 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." - }, - { - "name": "salesShipmentTrackRepositoryV1", - "description": "Shipment track repository 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." - }, - { - "name": "salesShipOrderV1", - "description": "Class ShipOrderInterface" - }, - { - "name": "salesTransactionRepositoryV1", - "description": "Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on." - }, - { - "name": "salesInvoiceOrderV1", - "description": "Class InvoiceOrderInterface" - }, - { - "name": "checkoutGuestShippingInformationManagementV1", - "description": "Interface for managing guest shipping address information" - }, - { - "name": "checkoutShippingInformationManagementV1", - "description": "Interface for managing customer shipping address information" - }, - { - "name": "checkoutTotalsInformationManagementV1", - "description": "Interface for quote totals calculation" - }, - { - "name": "checkoutGuestTotalsInformationManagementV1", - "description": "Interface for guest quote totals calculation" - }, - { - "name": "checkoutGuestPaymentInformationManagementV1", - "description": "Interface for managing guest payment information" - }, - { - "name": "checkoutPaymentInformationManagementV1", - "description": "Interface for managing quote payment information" - }, - { - "name": "salesRuleRuleRepositoryV1", - "description": "Sales rule CRUD interface" - }, - { - "name": "salesRuleCouponRepositoryV1", - "description": "Coupon CRUD interface" - }, - { - "name": "salesRuleCouponManagementV1", - "description": "Coupon management interface" - }, - { - "name": "configurableProductLinkManagementV1", - "description": "Manage children products of configurable product" - }, - { - "name": "configurableProductConfigurableProductManagementV1", - "description": "Interface ConfigurableProductManagementInterface" - }, - { - "name": "configurableProductOptionRepositoryV1", - "description": "Manage options of configurable product" - }, - { - "name": "downloadableLinkRepositoryV1", - "description": "Interface LinkRepositoryInterface" - }, - { - "name": "downloadableSampleRepositoryV1", - "description": "Interface SampleRepositoryInterface" - }, - { - "name": "checkoutAgreementsCheckoutAgreementsRepositoryV1", - "description": "Interface CheckoutAgreementsRepositoryInterface" - }, - { - "name": "taxTaxRateRepositoryV1", - "description": "Tax rate CRUD interface." - }, - { - "name": "taxTaxRuleRepositoryV1", - "description": "Tax rule CRUD interface." - }, - { - "name": "taxTaxClassRepositoryV1", - "description": "Tax class CRUD interface." - }, - { - "name": "companyCompanyRepositoryV1", - "description": "A repository interface for company entity that provides basic CRUD operations." - }, - { - "name": "companyTeamRepositoryV1", - "description": "Interface for basic CRUD operations for team entity." - }, - { - "name": "companyCompanyHierarchyV1", - "description": "Interface for working with company hierarchy." - }, - { - "name": "companyRoleRepositoryV1", - "description": "A repository interface for role entity that provides basic CRUD operations." - }, - { - "name": "companyAclV1", - "description": "Access control list interface." - }, - { - "name": "integrationAdminTokenServiceV1", - "description": "Interface providing token generation for Admins" - }, - { - "name": "integrationCustomerTokenServiceV1", - "description": "Interface providing token generation for Customers" - }, - { - "name": "analyticsLinkProviderV1", - "description": "Provides link to file with collected report data." - }, - { - "name": "customerBalanceBalanceManagementFromQuoteV1", - "description": "Customer balance(store credit) operations." - }, - { - "name": "negotiableQuoteNegotiableQuoteManagementV1", - "description": "Interface for managing quotes." - }, - { - "name": "negotiableQuoteNegotiableQuotePriceManagementV1", - "description": "Interface for updating quote prices in case price changes occur in system." - }, - { - "name": "negotiableQuoteAttachmentContentManagementV1", - "description": "Interface for retrieving the list of negotiable quotes attachments." - }, - { - "name": "negotiableQuoteCommentLocatorV1", - "description": "Interface for load quote comments with attachment." - }, - { - "name": "negotiableQuoteNegotiableQuoteShippingManagementV1", - "description": "Interface for add and update negotiable quote shipping method." - }, - { - "name": "negotiableQuotePaymentInformationManagementV1", - "description": "Interface for managing quote payment information" - }, - { - "name": "negotiableQuoteShippingInformationManagementV1", - "description": "Interface for managing customer shipping address information" - }, - { - "name": "negotiableQuoteShipmentEstimationV1", - "description": "Interface ShipmentManagementInterface" - }, - { - "name": "negotiableQuoteShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "negotiableQuoteNegotiableCartRepositoryV1", - "description": "Interface is intended to be used in webapi only. For other cases CartRepositoryInterface should be used." - }, - { - "name": "negotiableQuoteBillingAddressManagementV1", - "description": "Interface BillingAddressManagementInterface" - }, - { - "name": "negotiableQuoteCartTotalRepositoryV1", - "description": "Interface CartTotalRepositoryInterface" - }, - { - "name": "negotiableQuoteCouponManagementV1", - "description": "Coupon management service interface." - }, - { - "name": "negotiableQuoteGiftCardAccountManagementV1", - "description": "Interface GiftCardAccountManagementInterface" - }, - { - "name": "giftCardAccountGiftCardAccountManagementV1", - "description": "Interface GiftCardAccountManagementInterface" - }, - { - "name": "giftCardAccountGuestGiftCardAccountManagementV1", - "description": "Interface GuestGiftCardAccountManagementInterface" - }, - { - "name": "sharedCatalogSharedCatalogRepositoryV1", - "description": "" - }, - { - "name": "sharedCatalogCompanyManagementV1", - "description": "Shared catalog companies actions." - }, - { - "name": "sharedCatalogProductManagementV1", - "description": "Shared catalog products actions." - }, - { - "name": "sharedCatalogCategoryManagementV1", - "description": "Shared catalog products actions." - }, - { - "name": "giftMessageCartRepositoryV1", - "description": "Interface CartRepositoryInterface" - }, - { - "name": "giftMessageItemRepositoryV1", - "description": "Interface ItemRepositoryInterface" - }, - { - "name": "giftMessageGuestCartRepositoryV1", - "description": "Interface GuestCartRepositoryInterface" - }, - { - "name": "giftMessageGuestItemRepositoryV1", - "description": "Interface GuestItemRepositoryInterface" - }, - { - "name": "giftRegistryShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "giftRegistryGuestCartShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "giftWrappingWrappingRepositoryV1", - "description": "Interface WrappingRepositoryInterface" - }, - { - "name": "rewardRewardManagementV1", - "description": "Interface RewardManagementInterface" - }, - { - "name": "rmaTrackManagementV1", - "description": "Interface TrackManagementInterface" - }, - { - "name": "rmaRmaRepositoryV1", - "description": "Interface RmaRepositoryInterface" - }, - { - "name": "rmaCommentManagementV1", - "description": "Interface CommentRepositoryInterface" - }, - { - "name": "rmaRmaManagementV1", - "description": "Interface RmaManagementInterface" - }, - { - "name": "rmaRmaAttributesManagementV1", - "description": "Interface RmaAttributesManagementInterface" - }, - { - "name": "companyCreditCreditLimitRepositoryV1", - "description": "Interface for credit limit repository for CRUD operations." - }, - { - "name": "companyCreditCreditLimitManagementV1", - "description": "Credit Limit management interface." - }, - { - "name": "companyCreditCreditBalanceManagementV1", - "description": "Interface for management decrease and increase credit balance operations." - }, - { - "name": "companyCreditCreditHistoryManagementV1", - "description": "Update credit history log and retrieve history which match a specified criteria." - }, - { - "name": "asynchronousOperationsBulkStatusV1", - "description": "Interface BulkStatusInterface Bulk summary data with list of operations items short data." - }, - { - "name": "worldpayGuestPaymentInformationManagementProxyV1", - "description": "Interface GuestPaymentInformationManagementProxyInterface" - }, - { - "name": "amazonPaymentAddressManagementV1", - "description": "" - }, - { - "name": "amazonPaymentOrderInformationManagementV1", - "description": "" - }, - { - "name": "temandoShippingQuoteCartDeliveryOptionManagementV1", - "description": "CartDeliveryOptionManagementInterface" - }, - { - "name": "temandoShippingQuoteGuestCartDeliveryOptionManagementV1", - "description": "GuestCartDeliveryOptionManagementInterface" - }, - { - "name": "temandoShippingRmaRmaShipmentManagementV1", - "description": "Manage RMA Shipments" - }, - { - "name": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1", - "description": "Process Collection Point Search (Guest Checkout)" - }, - { - "name": "temandoShippingCollectionPointCartCollectionPointManagementV1", - "description": "Process Collection Point Search" - }, - { - "name": "temandoShippingQuoteGuestCartCheckoutFieldManagementV1", - "description": "Interface GuestCartCheckoutFieldManagementInterface Persist value-added services as selected during guest checkout." - }, - { - "name": "temandoShippingQuoteCartCheckoutFieldManagementV1", - "description": "Interface CartCheckoutFieldManagementInterface Persist value-added services as selected during logged-in checkout." - } - ], - "paths": { - "/V1/store/storeViews": { - "get": { - "tags": [ - "storeStoreRepositoryV1" - ], - "description": "Retrieve list of all stores", - "operationId": "storeStoreRepositoryV1GetListGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-store-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/store/storeGroups": { - "get": { - "tags": [ - "storeGroupRepositoryV1" - ], - "description": "Retrieve list of all groups", - "operationId": "storeGroupRepositoryV1GetListGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-group-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/store/websites": { - "get": { - "tags": [ - "storeWebsiteRepositoryV1" - ], - "description": "Retrieve list of all websites", - "operationId": "storeWebsiteRepositoryV1GetListGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-website-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/store/storeConfigs": { - "get": { - "tags": [ - "storeStoreConfigManagerV1" - ], - "description": "", - "operationId": "storeStoreConfigManagerV1GetStoreConfigsGet", - "parameters": [ - { - "name": "storeCodes", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-store-config-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/directory/currency": { - "get": { - "tags": [ - "directoryCurrencyInformationAcquirerV1" - ], - "description": "Get currency information for the store.", - "operationId": "directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/directory-data-currency-information-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/directory/countries": { - "get": { - "tags": [ - "directoryCountryInformationAcquirerV1" - ], - "description": "Get all countries and regions information for the store.", - "operationId": "directoryCountryInformationAcquirerV1GetCountriesInfoGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/directory-data-country-information-interface" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/directory/countries/{countryId}": { - "get": { - "tags": [ - "directoryCountryInformationAcquirerV1" - ], - "description": "Get country and region information for the store.", - "operationId": "directoryCountryInformationAcquirerV1GetCountryInfoGet", - "parameters": [ - { - "name": "countryId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/directory-data-country-information-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/eav/attribute-sets/list": { - "get": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "description": "Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "eavAttributeSetRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/eav/attribute-sets/{attributeSetId}": { - "get": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "description": "Retrieve attribute set information based on given ID", - "operationId": "eavAttributeSetRepositoryV1GetGet", - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "description": "Remove attribute set by given ID", - "operationId": "eavAttributeSetRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "description": "Save attribute set data", - "operationId": "eavAttributeSetRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/eav/attribute-sets": { - "post": { - "tags": [ - "eavAttributeSetManagementV1" - ], - "description": "Create attribute set from data", - "operationId": "eavAttributeSetManagementV1CreatePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/{id}": { - "get": { - "tags": [ - "customerGroupRepositoryV1" - ], - "description": "Get customer group by group ID.", - "operationId": "customerGroupRepositoryV1GetByIdGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "customerGroupRepositoryV1" - ], - "description": "Save customer group.", - "operationId": "customerGroupRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "customerGroupRepositoryV1" - ], - "description": "Delete customer group by ID.", - "operationId": "customerGroupRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/search": { - "get": { - "tags": [ - "customerGroupRepositoryV1" - ], - "description": "Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "customerGroupRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups": { - "post": { - "tags": [ - "customerGroupRepositoryV1" - ], - "description": "Save customer group.", - "operationId": "customerGroupRepositoryV1SavePost", - "parameters": [ - { - "name": "customerGroupRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "group" - ], - "properties": { - "group": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/default/{storeId}": { - "get": { - "tags": [ - "customerGroupManagementV1" - ], - "description": "Get default customer group.", - "operationId": "customerGroupManagementV1GetDefaultGroupGet", - "parameters": [ - { - "name": "storeId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/default": { - "get": { - "tags": [ - "customerGroupManagementV1" - ], - "description": "Get default customer group.", - "operationId": "customerGroupManagementV1GetDefaultGroupGet", - "parameters": [ - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/{id}/permissions": { - "get": { - "tags": [ - "customerGroupManagementV1" - ], - "description": "Check if customer group can be deleted.", - "operationId": "customerGroupManagementV1IsReadonlyGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/default/{id}": { - "put": { - "tags": [ - "customerCustomerGroupConfigV1" - ], - "description": "Set system default customer group.", - "operationId": "customerCustomerGroupConfigV1SetDefaultCustomerGroupPut", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer/attribute/{attributeCode}": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Retrieve attribute metadata.", - "operationId": "customerCustomerMetadataV1GetAttributeMetadataGet", - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer/form/{formCode}": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Retrieve all attributes filtered by form code", - "operationId": "customerCustomerMetadataV1GetAttributesGet", - "parameters": [ - { - "name": "formCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Get all attribute metadata.", - "operationId": "customerCustomerMetadataV1GetAllAttributesMetadataGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer/custom": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Get custom attributes metadata for the given data interface.", - "operationId": "customerCustomerMetadataV1GetCustomAttributesMetadataGet", - "parameters": [ - { - "name": "dataInterfaceName", - "in": "query", - "type": "string", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress/attribute/{attributeCode}": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Retrieve attribute metadata.", - "operationId": "customerAddressMetadataV1GetAttributeMetadataGet", - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress/form/{formCode}": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Retrieve all attributes filtered by form code", - "operationId": "customerAddressMetadataV1GetAttributesGet", - "parameters": [ - { - "name": "formCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Get all attribute metadata.", - "operationId": "customerAddressMetadataV1GetAllAttributesMetadataGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress/custom": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Get custom attributes metadata for the given data interface.", - "operationId": "customerAddressMetadataV1GetCustomAttributesMetadataGet", - "parameters": [ - { - "name": "dataInterfaceName", - "in": "query", - "type": "string", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}": { - "get": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Get customer by Customer ID.", - "operationId": "customerCustomerRepositoryV1GetByIdGet", - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Create or update a customer.", - "operationId": "customerCustomerRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Delete customer by Customer ID.", - "operationId": "customerCustomerRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me": { - "put": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Create or update a customer.", - "operationId": "customerCustomerRepositoryV1SavePut", - "parameters": [ - { - "name": "customerCustomerRepositoryV1SavePutBody", - "in": "body", - "schema": { - "required": [ - "customer" - ], - "properties": { - "customer": { - "$ref": "#/definitions/customer-data-customer-interface" - }, - "passwordHash": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Get customer by Customer ID.", - "operationId": "customerCustomerRepositoryV1GetByIdGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/search": { - "get": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "customerCustomerRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Create customer account. Perform necessary business operations like sending email.", - "operationId": "customerAccountManagementV1CreateAccountPost", - "parameters": [ - { - "name": "customerAccountManagementV1CreateAccountPostBody", - "in": "body", - "schema": { - "required": [ - "customer" - ], - "properties": { - "customer": { - "$ref": "#/definitions/customer-data-customer-interface" - }, - "password": { - "type": "string" - }, - "redirectUrl": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/activate": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Activate a customer account using a key that was sent in a confirmation email.", - "operationId": "customerAccountManagementV1ActivateByIdPut", - "parameters": [ - { - "name": "customerAccountManagementV1ActivateByIdPutBody", - "in": "body", - "schema": { - "required": [ - "confirmationKey" - ], - "properties": { - "confirmationKey": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{email}/activate": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Activate a customer account using a key that was sent in a confirmation email.", - "operationId": "customerAccountManagementV1ActivatePut", - "parameters": [ - { - "name": "email", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "customerAccountManagementV1ActivatePutBody", - "in": "body", - "schema": { - "required": [ - "confirmationKey" - ], - "properties": { - "confirmationKey": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/password": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Change customer password.", - "operationId": "customerAccountManagementV1ChangePasswordByIdPut", - "parameters": [ - { - "name": "customerAccountManagementV1ChangePasswordByIdPutBody", - "in": "body", - "schema": { - "required": [ - "currentPassword", - "newPassword" - ], - "properties": { - "currentPassword": { - "type": "string" - }, - "newPassword": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Check if password reset token is valid.", - "operationId": "customerAccountManagementV1ValidateResetPasswordLinkTokenGet", - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true, - "description": "If 0 is given then a customer will be matched by the RP token." - }, - { - "name": "resetPasswordLinkToken", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "True if the token is valid" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/password": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Send an email to the customer with a password reset link.", - "operationId": "customerAccountManagementV1InitiatePasswordResetPut", - "parameters": [ - { - "name": "customerAccountManagementV1InitiatePasswordResetPutBody", - "in": "body", - "schema": { - "required": [ - "email", - "template" - ], - "properties": { - "email": { - "type": "string" - }, - "template": { - "type": "string" - }, - "websiteId": { - "type": "integer" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/resetPassword": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Reset customer password.", - "operationId": "customerAccountManagementV1ResetPasswordPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/confirm": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Gets the account confirmation status.", - "operationId": "customerAccountManagementV1GetConfirmationStatusGet", - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/confirm": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Resend confirmation email.", - "operationId": "customerAccountManagementV1ResendConfirmationPost", - "parameters": [ - { - "name": "customerAccountManagementV1ResendConfirmationPostBody", - "in": "body", - "schema": { - "required": [ - "email", - "websiteId" - ], - "properties": { - "email": { - "type": "string" - }, - "websiteId": { - "type": "integer" - }, - "redirectUrl": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/validate": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Validate customer data.", - "operationId": "customerAccountManagementV1ValidatePut", - "parameters": [ - { - "name": "customerAccountManagementV1ValidatePutBody", - "in": "body", - "schema": { - "required": [ - "customer" - ], - "properties": { - "customer": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-validation-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/permissions/readonly": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Check if customer can be deleted.", - "operationId": "customerAccountManagementV1IsReadonlyGet", - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/isEmailAvailable": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Check if given email is associated with a customer account in given website.", - "operationId": "customerAccountManagementV1IsEmailAvailablePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/billingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default billing address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultBillingAddressGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/billingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default billing address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultBillingAddressGet", - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/shippingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default shipping address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultShippingAddressGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/shippingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default shipping address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultShippingAddressGet", - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/addresses/{addressId}": { - "get": { - "tags": [ - "customerAddressRepositoryV1" - ], - "description": "Retrieve customer address.", - "operationId": "customerAddressRepositoryV1GetByIdGet", - "parameters": [ - { - "name": "addressId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/addresses/{addressId}": { - "delete": { - "tags": [ - "customerAddressRepositoryV1" - ], - "description": "Delete customer address by ID.", - "operationId": "customerAddressRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "addressId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/modules": { - "get": { - "tags": [ - "backendModuleServiceV1" - ], - "description": "Returns an array of enabled modules", - "operationId": "backendModuleServiceV1GetModulesGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage/{pageId}": { - "get": { - "tags": [ - "cmsPageRepositoryV1" - ], - "description": "Retrieve page.", - "operationId": "cmsPageRepositoryV1GetByIdGet", - "parameters": [ - { - "name": "pageId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "cmsPageRepositoryV1" - ], - "description": "Delete page by ID.", - "operationId": "cmsPageRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "pageId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage/search": { - "get": { - "tags": [ - "cmsPageRepositoryV1" - ], - "description": "Retrieve pages matching the specified criteria.", - "operationId": "cmsPageRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage": { - "post": { - "tags": [ - "cmsPageRepositoryV1" - ], - "description": "Save page.", - "operationId": "cmsPageRepositoryV1SavePost", - "parameters": [ - { - "name": "cmsPageRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "page" - ], - "properties": { - "page": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage/{id}": { - "put": { - "tags": [ - "cmsPageRepositoryV1" - ], - "description": "Save page.", - "operationId": "cmsPageRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock/{blockId}": { - "get": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "description": "Retrieve block.", - "operationId": "cmsBlockRepositoryV1GetByIdGet", - "parameters": [ - { - "name": "blockId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "description": "Delete block by ID.", - "operationId": "cmsBlockRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "blockId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock/search": { - "get": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "description": "Retrieve blocks matching the specified criteria.", - "operationId": "cmsBlockRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock": { - "post": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "description": "Save block.", - "operationId": "cmsBlockRepositoryV1SavePost", - "parameters": [ - { - "name": "cmsBlockRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "block" - ], - "properties": { - "block": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock/{id}": { - "put": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "description": "Save block.", - "operationId": "cmsBlockRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products": { - "post": { - "tags": [ - "catalogProductRepositoryV1" - ], - "description": "Create product", - "operationId": "catalogProductRepositoryV1SavePost", - "parameters": [ - { - "name": "catalogProductRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "product" - ], - "properties": { - "product": { - "$ref": "#/definitions/catalog-data-product-interface" - }, - "saveOptions": { - "type": "boolean" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogProductRepositoryV1" - ], - "description": "Get product list", - "operationId": "catalogProductRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}": { - "put": { - "tags": [ - "catalogProductRepositoryV1" - ], - "description": "Create product", - "operationId": "catalogProductRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductRepositoryV1" - ], - "description": "", - "operationId": "catalogProductRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "Will returned True if deleted" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogProductRepositoryV1" - ], - "description": "Get info about product by product SKU", - "operationId": "catalogProductRepositoryV1GetGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "editMode", - "in": "query", - "type": "boolean", - "required": false - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - }, - { - "name": "forceReload", - "in": "query", - "type": "boolean", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/types": { - "get": { - "tags": [ - "catalogProductAttributeTypesListV1" - ], - "description": "Retrieve list of product attribute types", - "operationId": "catalogProductAttributeTypesListV1GetItemsGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/{attributeCode}": { - "get": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "description": "Retrieve specific attribute", - "operationId": "catalogProductAttributeRepositoryV1GetGet", - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "description": "Save attribute data", - "operationId": "catalogProductAttributeRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "description": "Delete Attribute by id", - "operationId": "catalogProductAttributeRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes": { - "get": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "description": "Retrieve all attributes for entity type", - "operationId": "catalogProductAttributeRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "description": "Save attribute data", - "operationId": "catalogProductAttributeRepositoryV1SavePost", - "parameters": [ - { - "name": "catalogProductAttributeRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "attribute" - ], - "properties": { - "attribute": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/attributes/{attributeCode}": { - "get": { - "tags": [ - "catalogCategoryAttributeRepositoryV1" - ], - "description": "Retrieve specific attribute", - "operationId": "catalogCategoryAttributeRepositoryV1GetGet", - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-attribute-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/attributes": { - "get": { - "tags": [ - "catalogCategoryAttributeRepositoryV1" - ], - "description": "Retrieve all attributes for entity type", - "operationId": "catalogCategoryAttributeRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-attribute-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/attributes/{attributeCode}/options": { - "get": { - "tags": [ - "catalogCategoryAttributeOptionManagementV1" - ], - "description": "Retrieve list of attribute options", - "operationId": "catalogCategoryAttributeOptionManagementV1GetItemsGet", - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/eav-data-attribute-option-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/types": { - "get": { - "tags": [ - "catalogProductTypeListV1" - ], - "description": "Retrieve available product types", - "operationId": "catalogProductTypeListV1GetProductTypesGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/sets/list": { - "get": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "description": "Retrieve list of Attribute Sets", - "operationId": "catalogAttributeSetRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}": { - "get": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "description": "Retrieve attribute set information based on given ID", - "operationId": "catalogAttributeSetRepositoryV1GetGet", - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "description": "Remove attribute set by given ID", - "operationId": "catalogAttributeSetRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "description": "Save attribute set data", - "operationId": "catalogAttributeSetRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets": { - "post": { - "tags": [ - "catalogAttributeSetManagementV1" - ], - "description": "Create attribute set from data", - "operationId": "catalogAttributeSetManagementV1CreatePost", - "parameters": [ - { - "name": "catalogAttributeSetManagementV1CreatePostBody", - "in": "body", - "schema": { - "required": [ - "attributeSet", - "skeletonId" - ], - "properties": { - "attributeSet": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - }, - "skeletonId": { - "type": "integer" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}/attributes": { - "get": { - "tags": [ - "catalogProductAttributeManagementV1" - ], - "description": "Retrieve related attributes based on given attribute set ID", - "operationId": "catalogProductAttributeManagementV1GetAttributesGet", - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/attributes": { - "post": { - "tags": [ - "catalogProductAttributeManagementV1" - ], - "description": "Assign attribute to attribute set", - "operationId": "catalogProductAttributeManagementV1AssignPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}": { - "delete": { - "tags": [ - "catalogProductAttributeManagementV1" - ], - "description": "Remove attribute from attribute set", - "operationId": "catalogProductAttributeManagementV1UnassignDelete", - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/groups/list": { - "get": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "description": "Retrieve list of attribute groups", - "operationId": "catalogProductAttributeGroupRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-group-search-results-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/groups": { - "post": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "description": "Save attribute group", - "operationId": "catalogProductAttributeGroupRepositoryV1SavePost", - "parameters": [ - { - "name": "catalogProductAttributeGroupRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "group" - ], - "properties": { - "group": { - "$ref": "#/definitions/eav-data-attribute-group-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}/groups": { - "put": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "description": "Save attribute group", - "operationId": "catalogProductAttributeGroupRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/groups/{groupId}": { - "delete": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "description": "Remove attribute group by id", - "operationId": "catalogProductAttributeGroupRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "groupId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/{attributeCode}/options": { - "get": { - "tags": [ - "catalogProductAttributeOptionManagementV1" - ], - "description": "Retrieve list of attribute options", - "operationId": "catalogProductAttributeOptionManagementV1GetItemsGet", - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/eav-data-attribute-option-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "catalogProductAttributeOptionManagementV1" - ], - "description": "Add option to attribute", - "operationId": "catalogProductAttributeOptionManagementV1AddPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/{attributeCode}/options/{optionId}": { - "delete": { - "tags": [ - "catalogProductAttributeOptionManagementV1" - ], - "description": "Delete option from attribute", - "operationId": "catalogProductAttributeOptionManagementV1DeleteDelete", - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "optionId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/media/types/{attributeSetName}": { - "get": { - "tags": [ - "catalogProductMediaAttributeManagementV1" - ], - "description": "Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.", - "operationId": "catalogProductMediaAttributeManagementV1GetListGet", - "parameters": [ - { - "name": "attributeSetName", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "list of media attributes", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/media/{entryId}": { - "get": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "description": "Return information about gallery entry", - "operationId": "catalogProductAttributeMediaGalleryManagementV1GetGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "entryId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "description": "Update gallery entry", - "operationId": "catalogProductAttributeMediaGalleryManagementV1UpdatePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "description": "Remove gallery entry", - "operationId": "catalogProductAttributeMediaGalleryManagementV1RemoveDelete", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "entryId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/media": { - "post": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "description": "Create new gallery entry", - "operationId": "catalogProductAttributeMediaGalleryManagementV1CreatePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "gallery entry ID" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "description": "Retrieve the list of gallery entries associated with given product", - "operationId": "catalogProductAttributeMediaGalleryManagementV1GetListGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers": { - "get": { - "tags": [ - "catalogProductTierPriceManagementV1" - ], - "description": "Get tier price of product", - "operationId": "catalogProductTierPriceManagementV1GetListGet", - "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'" - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-tier-price-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}": { - "post": { - "tags": [ - "catalogProductTierPriceManagementV1" - ], - "description": "Create tier price for product", - "operationId": "catalogProductTierPriceManagementV1AddPost", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}": { - "delete": { - "tags": [ - "catalogProductTierPriceManagementV1" - ], - "description": "Remove tier price from product", - "operationId": "catalogProductTierPriceManagementV1RemoveDelete", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/tier-prices-information": { - "post": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "description": "Return product prices. In case of at least one of skus is not found exception will be thrown.", - "operationId": "catalogTierPriceStorageV1GetPost", - "parameters": [ - { - "name": "catalogTierPriceStorageV1GetPostBody", - "in": "body", - "schema": { - "required": [ - "skus" - ], - "properties": { - "skus": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-tier-price-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/tier-prices": { - "post": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "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", - "parameters": [ - { - "name": "catalogTierPriceStorageV1UpdatePostBody", - "in": "body", - "schema": { - "required": [ - "prices" - ], - "properties": { - "prices": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-tier-price-interface" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "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", - "parameters": [ - { - "name": "catalogTierPriceStorageV1ReplacePutBody", - "in": "body", - "schema": { - "required": [ - "prices" - ], - "properties": { - "prices": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-tier-price-interface" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/tier-prices-delete": { - "post": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "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", - "parameters": [ - { - "name": "catalogTierPriceStorageV1DeletePostBody", - "in": "body", - "schema": { - "required": [ - "prices" - ], - "properties": { - "prices": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-tier-price-interface" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/base-prices-information": { - "post": { - "tags": [ - "catalogBasePriceStorageV1" - ], - "description": "Return product prices. In case of at least one of skus is not found exception will be thrown.", - "operationId": "catalogBasePriceStorageV1GetPost", - "parameters": [ - { - "name": "catalogBasePriceStorageV1GetPostBody", - "in": "body", - "schema": { - "required": [ - "skus" - ], - "properties": { - "skus": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-base-price-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/base-prices": { - "post": { - "tags": [ - "catalogBasePriceStorageV1" - ], - "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", - "parameters": [ - { - "name": "catalogBasePriceStorageV1UpdatePostBody", - "in": "body", - "schema": { - "required": [ - "prices" - ], - "properties": { - "prices": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-base-price-interface" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/cost-information": { - "post": { - "tags": [ - "catalogCostStorageV1" - ], - "description": "Return product prices. In case of at least one of skus is not found exception will be thrown.", - "operationId": "catalogCostStorageV1GetPost", - "parameters": [ - { - "name": "catalogCostStorageV1GetPostBody", - "in": "body", - "schema": { - "required": [ - "skus" - ], - "properties": { - "skus": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-cost-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/cost": { - "post": { - "tags": [ - "catalogCostStorageV1" - ], - "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", - "parameters": [ - { - "name": "catalogCostStorageV1UpdatePostBody", - "in": "body", - "schema": { - "required": [ - "prices" - ], - "properties": { - "prices": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-cost-interface" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/cost-delete": { - "post": { - "tags": [ - "catalogCostStorageV1" - ], - "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", - "parameters": [ - { - "name": "catalogCostStorageV1DeletePostBody", - "in": "body", - "schema": { - "required": [ - "skus" - ], - "properties": { - "skus": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "Will return True if deleted." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/special-price-information": { - "post": { - "tags": [ - "catalogSpecialPriceStorageV1" - ], - "description": "Return product's special price. In case of at least one of skus is not found exception will be thrown.", - "operationId": "catalogSpecialPriceStorageV1GetPost", - "parameters": [ - { - "name": "catalogSpecialPriceStorageV1GetPostBody", - "in": "body", - "schema": { - "required": [ - "skus" - ], - "properties": { - "skus": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-special-price-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/special-price": { - "post": { - "tags": [ - "catalogSpecialPriceStorageV1" - ], - "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", - "parameters": [ - { - "name": "catalogSpecialPriceStorageV1UpdatePostBody", - "in": "body", - "schema": { - "required": [ - "prices" - ], - "properties": { - "prices": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-special-price-interface" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/special-price-delete": { - "post": { - "tags": [ - "catalogSpecialPriceStorageV1" - ], - "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", - "parameters": [ - { - "name": "catalogSpecialPriceStorageV1DeletePostBody", - "in": "body", - "schema": { - "required": [ - "prices" - ], - "properties": { - "prices": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-special-price-interface" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}": { - "delete": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "description": "Delete category by identifier", - "operationId": "catalogCategoryRepositoryV1DeleteByIdentifierDelete", - "parameters": [ - { - "name": "categoryId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "Will returned True if deleted" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "description": "Get info about category by category id", - "operationId": "catalogCategoryRepositoryV1GetGet", - "parameters": [ - { - "name": "categoryId", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories": { - "post": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "description": "Create category service", - "operationId": "catalogCategoryRepositoryV1SavePost", - "parameters": [ - { - "name": "catalogCategoryRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "category" - ], - "properties": { - "category": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogCategoryManagementV1" - ], - "description": "Retrieve list of categories", - "operationId": "catalogCategoryManagementV1GetTreeGet", - "parameters": [ - { - "name": "rootCategoryId", - "in": "query", - "type": "integer", - "required": false - }, - { - "name": "depth", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-tree-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{id}": { - "put": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "description": "Create category service", - "operationId": "catalogCategoryRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}/move": { - "put": { - "tags": [ - "catalogCategoryManagementV1" - ], - "description": "Move category", - "operationId": "catalogCategoryManagementV1MovePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/list": { - "get": { - "tags": [ - "catalogCategoryListV1" - ], - "description": "Get category list", - "operationId": "catalogCategoryListV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/options/types": { - "get": { - "tags": [ - "catalogProductCustomOptionTypeListV1" - ], - "description": "Get custom option types", - "operationId": "catalogProductCustomOptionTypeListV1GetItemsGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-custom-option-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/options": { - "get": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "description": "Get the list of custom options for a specific product", - "operationId": "catalogProductCustomOptionRepositoryV1GetListGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/options/{optionId}": { - "get": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "description": "Get custom option for a specific product", - "operationId": "catalogProductCustomOptionRepositoryV1GetGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "optionId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "description": "", - "operationId": "catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "optionId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/options": { - "post": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "description": "Save Custom Option", - "operationId": "catalogProductCustomOptionRepositoryV1SavePost", - "parameters": [ - { - "name": "catalogProductCustomOptionRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "option" - ], - "properties": { - "option": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/options/{optionId}": { - "put": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "description": "Save Custom Option", - "operationId": "catalogProductCustomOptionRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/links/types": { - "get": { - "tags": [ - "catalogProductLinkTypeListV1" - ], - "description": "Retrieve information about available product link types", - "operationId": "catalogProductLinkTypeListV1GetItemsGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-link-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/links/{type}/attributes": { - "get": { - "tags": [ - "catalogProductLinkTypeListV1" - ], - "description": "Provide a list of the product link type attributes", - "operationId": "catalogProductLinkTypeListV1GetItemAttributesGet", - "parameters": [ - { - "name": "type", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-link-attribute-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/links/{type}": { - "get": { - "tags": [ - "catalogProductLinkManagementV1" - ], - "description": "Provide the list of links for a specific product", - "operationId": "catalogProductLinkManagementV1GetLinkedItemsByTypeGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "type", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-link-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/links": { - "post": { - "tags": [ - "catalogProductLinkManagementV1" - ], - "description": "Assign a product link to another product", - "operationId": "catalogProductLinkManagementV1SetProductLinksPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductLinkRepositoryV1" - ], - "description": "Save product link", - "operationId": "catalogProductLinkRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/links/{type}/{linkedProductSku}": { - "delete": { - "tags": [ - "catalogProductLinkRepositoryV1" - ], - "description": "", - "operationId": "catalogProductLinkRepositoryV1DeleteByIdDelete", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}/products": { - "get": { - "tags": [ - "catalogCategoryLinkManagementV1" - ], - "description": "Get products assigned to category", - "operationId": "catalogCategoryLinkManagementV1GetAssignedProductsGet", - "parameters": [ - { - "name": "categoryId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-category-product-link-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "catalogCategoryLinkRepositoryV1" - ], - "description": "Assign a product to the required category", - "operationId": "catalogCategoryLinkRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if assigned" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogCategoryLinkRepositoryV1" - ], - "description": "Assign a product to the required category", - "operationId": "catalogCategoryLinkRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if assigned" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}/products/{sku}": { - "delete": { - "tags": [ - "catalogCategoryLinkRepositoryV1" - ], - "description": "Remove the product assignment from the category by category id and sku", - "operationId": "catalogCategoryLinkRepositoryV1DeleteByIdsDelete", - "parameters": [ - { - "name": "categoryId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if products successfully deleted" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/websites": { - "post": { - "tags": [ - "catalogProductWebsiteLinkRepositoryV1" - ], - "description": "Assign a product to the website", - "operationId": "catalogProductWebsiteLinkRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if website successfully assigned to product" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductWebsiteLinkRepositoryV1" - ], - "description": "Assign a product to the website", - "operationId": "catalogProductWebsiteLinkRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if website successfully assigned to product" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/websites/{websiteId}": { - "delete": { - "tags": [ - "catalogProductWebsiteLinkRepositoryV1" - ], - "description": "Remove the website assignment from the product by product sku", - "operationId": "catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "websiteId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if website successfully unassigned from product" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products-render-info": { - "get": { - "tags": [ - "catalogProductRenderListV1" - ], - "description": "Collect and retrieve the list of product render info This info contains raw prices and formated prices, product name, stock status, store_id, etc", - "operationId": "catalogProductRenderListV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": true - }, - { - "name": "currencyCode", - "in": "query", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-render-search-results-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}": { - "get": { - "tags": [ - "quoteCartRepositoryV1" - ], - "description": "Enables an administrative user to return information for a specified cart.", - "operationId": "quoteCartRepositoryV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quoteCartManagementV1" - ], - "description": "Assigns a specified customer to a specified shopping cart.", - "operationId": "quoteCartManagementV1AssignCustomerPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/search": { - "get": { - "tags": [ - "quoteCartRepositoryV1" - ], - "description": "Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quoteCartRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine": { - "put": { - "tags": [ - "quoteCartRepositoryV1" - ], - "description": "Save quote", - "operationId": "quoteCartRepositoryV1SavePut", - "parameters": [ - { - "name": "quoteCartRepositoryV1SavePutBody", - "in": "body", - "schema": { - "required": [ - "quote" - ], - "properties": { - "quote": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteCartManagementV1" - ], - "description": "Creates an empty cart and quote for a specified customer if customer does not have a cart yet.", - "operationId": "quoteCartManagementV1CreateEmptyCartForCustomerPost", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "new cart ID if customer did not have a cart or ID of the existing cart otherwise." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "quoteCartManagementV1" - ], - "description": "Returns information for the cart for a specified customer.", - "operationId": "quoteCartManagementV1GetCartForCustomerGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/": { - "post": { - "tags": [ - "quoteCartManagementV1" - ], - "description": "Creates an empty cart and quote for a guest.", - "operationId": "quoteCartManagementV1CreateEmptyCartPost", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Cart ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/carts": { - "post": { - "tags": [ - "quoteCartManagementV1" - ], - "description": "Creates an empty cart and quote for a specified customer if customer does not have a cart yet.", - "operationId": "quoteCartManagementV1CreateEmptyCartForCustomerPost", - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true, - "description": "The customer ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "new cart ID if customer did not have a cart or ID of the existing cart otherwise." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/order": { - "put": { - "tags": [ - "quoteCartManagementV1" - ], - "description": "Places an order for a specified cart.", - "operationId": "quoteCartManagementV1PlaceOrderPut", - "parameters": [ - { - "name": "quoteCartManagementV1PlaceOrderPutBody", - "in": "body", - "schema": { - "properties": { - "paymentMethod": { - "$ref": "#/definitions/quote-data-payment-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/order": { - "put": { - "tags": [ - "quoteCartManagementV1" - ], - "description": "Places an order for a specified cart.", - "operationId": "quoteCartManagementV1PlaceOrderPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}": { - "get": { - "tags": [ - "quoteGuestCartRepositoryV1" - ], - "description": "Enable a guest user to return information for a specified cart.", - "operationId": "quoteGuestCartRepositoryV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quoteGuestCartManagementV1" - ], - "description": "Assign a specified customer to a specified shopping cart.", - "operationId": "quoteGuestCartManagementV1AssignCustomerPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts": { - "post": { - "tags": [ - "quoteGuestCartManagementV1" - ], - "description": "Enable an customer or guest user to create an empty cart and quote for an anonymous customer.", - "operationId": "quoteGuestCartManagementV1CreateEmptyCartPost", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Cart ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/order": { - "put": { - "tags": [ - "quoteGuestCartManagementV1" - ], - "description": "Place an order for a specified cart.", - "operationId": "quoteGuestCartManagementV1PlaceOrderPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/shipping-methods": { - "get": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "description": "Lists applicable shipping methods for a specified quote.", - "operationId": "quoteShippingMethodManagementV1GetListGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/estimate-shipping-methods-by-address-id": { - "post": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "description": "Estimate shipping", - "operationId": "quoteShippingMethodManagementV1EstimateByAddressIdPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/shipping-methods": { - "get": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "description": "Lists applicable shipping methods for a specified quote.", - "operationId": "quoteShippingMethodManagementV1GetListGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/estimate-shipping-methods-by-address-id": { - "post": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "description": "Estimate shipping", - "operationId": "quoteShippingMethodManagementV1EstimateByAddressIdPost", - "parameters": [ - { - "name": "quoteShippingMethodManagementV1EstimateByAddressIdPostBody", - "in": "body", - "schema": { - "required": [ - "addressId" - ], - "properties": { - "addressId": { - "type": "integer", - "description": "The estimate address id" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "quoteShipmentEstimationV1" - ], - "description": "Estimate shipping by address and return list of available shipping methods", - "operationId": "quoteShipmentEstimationV1EstimateByExtendedAddressPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/estimate-shipping-methods": { - "post": { - "tags": [ - "quoteShipmentEstimationV1" - ], - "description": "Estimate shipping by address and return list of available shipping methods", - "operationId": "quoteShipmentEstimationV1EstimateByExtendedAddressPost", - "parameters": [ - { - "name": "quoteShipmentEstimationV1EstimateByExtendedAddressPostBody", - "in": "body", - "schema": { - "required": [ - "address" - ], - "properties": { - "address": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/shipping-methods": { - "get": { - "tags": [ - "quoteGuestShippingMethodManagementV1" - ], - "description": "List applicable shipping methods for a specified quote.", - "operationId": "quoteGuestShippingMethodManagementV1GetListGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "quoteGuestShipmentEstimationV1" - ], - "description": "Estimate shipping by address and return list of available shipping methods", - "operationId": "quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/items": { - "get": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Lists items that are assigned to a specified cart.", - "operationId": "quoteCartItemRepositoryV1GetListGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of items.", - "items": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{quoteId}/items": { - "post": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Add/update the specified cart item.", - "operationId": "quoteCartItemRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/items/{itemId}": { - "put": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Add/update the specified cart item.", - "operationId": "quoteCartItemRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Removes the specified item from the specified cart.", - "operationId": "quoteCartItemRepositoryV1DeleteByIdDelete", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/items": { - "get": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Lists items that are assigned to a specified cart.", - "operationId": "quoteCartItemRepositoryV1GetListGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of items.", - "items": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Add/update the specified cart item.", - "operationId": "quoteCartItemRepositoryV1SavePost", - "parameters": [ - { - "name": "quoteCartItemRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "cartItem" - ], - "properties": { - "cartItem": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/items/{itemId}": { - "put": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Add/update the specified cart item.", - "operationId": "quoteCartItemRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Removes the specified item from the specified cart.", - "operationId": "quoteCartItemRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "itemId", - "in": "path", - "type": "integer", - "required": true, - "description": "The item ID of the item to be removed." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/items": { - "get": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "description": "List items that are assigned to a specified cart.", - "operationId": "quoteGuestCartItemRepositoryV1GetListGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of items.", - "items": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "description": "Add/update the specified cart item.", - "operationId": "quoteGuestCartItemRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/items/{itemId}": { - "put": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "description": "Add/update the specified cart item.", - "operationId": "quoteGuestCartItemRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "description": "Remove the specified item from the specified cart.", - "operationId": "quoteGuestCartItemRepositoryV1DeleteByIdDelete", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/selected-payment-method": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Returns the payment method for a specified shopping cart.", - "operationId": "quotePaymentMethodManagementV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-payment-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Adds a specified payment method to a specified shopping cart.", - "operationId": "quotePaymentMethodManagementV1SetPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "redirect url or error message." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/payment-methods": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quotePaymentMethodManagementV1GetListGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of payment methods.", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/selected-payment-method": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Returns the payment method for a specified shopping cart.", - "operationId": "quotePaymentMethodManagementV1GetGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-payment-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Adds a specified payment method to a specified shopping cart.", - "operationId": "quotePaymentMethodManagementV1SetPut", - "parameters": [ - { - "name": "quotePaymentMethodManagementV1SetPutBody", - "in": "body", - "schema": { - "required": [ - "method" - ], - "properties": { - "method": { - "$ref": "#/definitions/quote-data-payment-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "redirect url or error message." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/payment-methods": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quotePaymentMethodManagementV1GetListGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of payment methods.", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/selected-payment-method": { - "get": { - "tags": [ - "quoteGuestPaymentMethodManagementV1" - ], - "description": "Return the payment method for a specified shopping cart.", - "operationId": "quoteGuestPaymentMethodManagementV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-payment-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quoteGuestPaymentMethodManagementV1" - ], - "description": "Add a specified payment method to a specified shopping cart.", - "operationId": "quoteGuestPaymentMethodManagementV1SetPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Payment method ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/payment-methods": { - "get": { - "tags": [ - "quoteGuestPaymentMethodManagementV1" - ], - "description": "List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quoteGuestPaymentMethodManagementV1GetListGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of payment methods.", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/billing-address": { - "get": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "description": "Returns the billing address for a specified quote.", - "operationId": "quoteBillingAddressManagementV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "description": "Assigns a specified billing address to a specified cart.", - "operationId": "quoteBillingAddressManagementV1AssignPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/billing-address": { - "get": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "description": "Returns the billing address for a specified quote.", - "operationId": "quoteBillingAddressManagementV1GetGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "description": "Assigns a specified billing address to a specified cart.", - "operationId": "quoteBillingAddressManagementV1AssignPost", - "parameters": [ - { - "name": "quoteBillingAddressManagementV1AssignPostBody", - "in": "body", - "schema": { - "required": [ - "address" - ], - "properties": { - "address": { - "$ref": "#/definitions/quote-data-address-interface" - }, - "useForShipping": { - "type": "boolean" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/billing-address": { - "get": { - "tags": [ - "quoteGuestBillingAddressManagementV1" - ], - "description": "Return the billing address for a specified quote.", - "operationId": "quoteGuestBillingAddressManagementV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteGuestBillingAddressManagementV1" - ], - "description": "Assign a specified billing address to a specified cart.", - "operationId": "quoteGuestBillingAddressManagementV1AssignPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/coupons": { - "get": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Returns information for a coupon in a specified cart.", - "operationId": "quoteCouponManagementV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "The coupon code data." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Deletes a coupon from a specified cart.", - "operationId": "quoteCouponManagementV1RemoveDelete", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/coupons/{couponCode}": { - "put": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Adds a coupon by code to a specified cart.", - "operationId": "quoteCouponManagementV1SetPut", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/coupons": { - "get": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Returns information for a coupon in a specified cart.", - "operationId": "quoteCouponManagementV1GetGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "The coupon code data." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Deletes a coupon from a specified cart.", - "operationId": "quoteCouponManagementV1RemoveDelete", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/coupons/{couponCode}": { - "put": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Adds a coupon by code to a specified cart.", - "operationId": "quoteCouponManagementV1SetPut", - "parameters": [ - { - "name": "couponCode", - "in": "path", - "type": "string", - "required": true, - "description": "The coupon code data." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/coupons": { - "get": { - "tags": [ - "quoteGuestCouponManagementV1" - ], - "description": "Return information for a coupon in a specified cart.", - "operationId": "quoteGuestCouponManagementV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "The coupon code data." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteGuestCouponManagementV1" - ], - "description": "Delete a coupon from a specified cart.", - "operationId": "quoteGuestCouponManagementV1RemoveDelete", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/coupons/{couponCode}": { - "put": { - "tags": [ - "quoteGuestCouponManagementV1" - ], - "description": "Add a coupon by code to a specified cart.", - "operationId": "quoteGuestCouponManagementV1SetPut", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/totals": { - "get": { - "tags": [ - "quoteCartTotalRepositoryV1" - ], - "description": "Returns quote totals data for a specified cart.", - "operationId": "quoteCartTotalRepositoryV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/totals": { - "get": { - "tags": [ - "quoteCartTotalRepositoryV1" - ], - "description": "Returns quote totals data for a specified cart.", - "operationId": "quoteCartTotalRepositoryV1GetGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collect-totals": { - "put": { - "tags": [ - "quoteGuestCartTotalManagementV1" - ], - "description": "Set shipping/billing methods and additional data for cart and collect totals for guest.", - "operationId": "quoteGuestCartTotalManagementV1CollectTotalsPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/totals": { - "get": { - "tags": [ - "quoteGuestCartTotalRepositoryV1" - ], - "description": "Return quote totals data for a specified cart.", - "operationId": "quoteGuestCartTotalRepositoryV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collect-totals": { - "put": { - "tags": [ - "quoteCartTotalManagementV1" - ], - "description": "Set shipping/billing methods and additional data for cart and collect totals.", - "operationId": "quoteCartTotalManagementV1CollectTotalsPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/stockItems/{productSku}": { - "get": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "description": "", - "operationId": "catalogInventoryStockRegistryV1GetStockItemBySkuGet", - "parameters": [ - { - "name": "productSku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "scopeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{productSku}/stockItems/{itemId}": { - "put": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "description": "", - "operationId": "catalogInventoryStockRegistryV1UpdateStockItemBySkuPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/stockItems/lowStock/": { - "get": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "description": "Retrieves a list of SKU's with low inventory qty", - "operationId": "catalogInventoryStockRegistryV1GetLowStockItemsGet", - "parameters": [ - { - "name": "scopeId", - "in": "query", - "type": "integer", - "required": true - }, - { - "name": "qty", - "in": "query", - "type": "number", - "required": true - }, - { - "name": "currentPage", - "in": "query", - "type": "integer", - "required": false - }, - { - "name": "pageSize", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-collection-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/stockStatuses/{productSku}": { - "get": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "description": "", - "operationId": "catalogInventoryStockRegistryV1GetStockStatusBySkuGet", - "parameters": [ - { - "name": "productSku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "scopeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-inventory-data-stock-status-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/links/{optionId}": { - "post": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "description": "Add child product to specified Bundle option by product sku", - "operationId": "bundleProductLinkManagementV1AddChildByProductSkuPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/links/{id}": { - "put": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "description": "", - "operationId": "bundleProductLinkManagementV1SaveChildPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{productSku}/children": { - "get": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "description": "Get all children for Bundle product", - "operationId": "bundleProductLinkManagementV1GetChildrenGet", - "parameters": [ - { - "name": "productSku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "optionId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/bundle-data-link-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}": { - "delete": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "description": "Remove product from Bundle product option", - "operationId": "bundleProductLinkManagementV1RemoveChildDelete", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/options/all": { - "get": { - "tags": [ - "bundleProductOptionRepositoryV1" - ], - "description": "Get all options for bundle product", - "operationId": "bundleProductOptionRepositoryV1GetListGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/bundle-data-option-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/options/{optionId}": { - "get": { - "tags": [ - "bundleProductOptionRepositoryV1" - ], - "description": "Get option for bundle product", - "operationId": "bundleProductOptionRepositoryV1GetGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "optionId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/bundle-data-option-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "bundleProductOptionRepositoryV1" - ], - "description": "Remove bundle option", - "operationId": "bundleProductOptionRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "optionId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/options/types": { - "get": { - "tags": [ - "bundleProductOptionTypeListV1" - ], - "description": "Get all types for options for bundle products", - "operationId": "bundleProductOptionTypeListV1GetItemsGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/bundle-data-option-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/options/add": { - "post": { - "tags": [ - "bundleProductOptionManagementV1" - ], - "description": "Add new option for bundle product", - "operationId": "bundleProductOptionManagementV1SavePost", - "parameters": [ - { - "name": "bundleProductOptionManagementV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "option" - ], - "properties": { - "option": { - "$ref": "#/definitions/bundle-data-option-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/options/{optionId}": { - "put": { - "tags": [ - "bundleProductOptionManagementV1" - ], - "description": "Add new option for bundle product", - "operationId": "bundleProductOptionManagementV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/requisition_lists": { - "post": { - "tags": [ - "requisitionListRequisitionListRepositoryV1" - ], - "description": "Save Requisition List", - "operationId": "requisitionListRequisitionListRepositoryV1SavePost", - "parameters": [ - { - "name": "requisitionListRequisitionListRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "requisitionList" - ], - "properties": { - "requisitionList": { - "$ref": "#/definitions/requisition-list-data-requisition-list-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/requisition-list-data-requisition-list-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/search": { - "get": { - "tags": [ - "searchV1" - ], - "description": "Make Full Text Search and return found Documents", - "operationId": "searchV1SearchGet", - "parameters": [ - { - "name": "searchCriteria[requestName]", - "in": "query", - "type": "string" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/framework-search-search-result-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}": { - "get": { - "tags": [ - "salesOrderRepositoryV1" - ], - "description": "Loads a specified order.", - "operationId": "salesOrderRepositoryV1GetGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders": { - "get": { - "tags": [ - "salesOrderRepositoryV1" - ], - "description": "Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesOrderRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/create": { - "put": { - "tags": [ - "salesOrderRepositoryV1" - ], - "description": "Performs persist operations for a specified order.", - "operationId": "salesOrderRepositoryV1SavePut", - "parameters": [ - { - "name": "salesOrderRepositoryV1SavePutBody", - "in": "body", - "schema": { - "required": [ - "entity" - ], - "properties": { - "entity": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/": { - "post": { - "tags": [ - "salesOrderRepositoryV1" - ], - "description": "Performs persist operations for a specified order.", - "operationId": "salesOrderRepositoryV1SavePost", - "parameters": [ - { - "name": "salesOrderRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "entity" - ], - "properties": { - "entity": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/statuses": { - "get": { - "tags": [ - "salesOrderManagementV1" - ], - "description": "Gets the status for a specified order.", - "operationId": "salesOrderManagementV1GetStatusGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Order status." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/cancel": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "description": "Cancels a specified order.", - "operationId": "salesOrderManagementV1CancelPost", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/emails": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "description": "Emails a user a specified order.", - "operationId": "salesOrderManagementV1NotifyPost", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/hold": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "description": "Holds a specified order.", - "operationId": "salesOrderManagementV1HoldPost", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/unhold": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "description": "Releases a specified order from hold status.", - "operationId": "salesOrderManagementV1UnHoldPost", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/comments": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "description": "Adds a comment to a specified order.", - "operationId": "salesOrderManagementV1AddCommentPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "salesOrderManagementV1" - ], - "description": "Lists comments for a specified order.", - "operationId": "salesOrderManagementV1GetCommentsListGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-status-history-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{parent_id}": { - "put": { - "tags": [ - "salesOrderAddressRepositoryV1" - ], - "description": "Performs persist operations for a specified order address.", - "operationId": "salesOrderAddressRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/items/{id}": { - "get": { - "tags": [ - "salesOrderItemRepositoryV1" - ], - "description": "Loads a specified order item.", - "operationId": "salesOrderItemRepositoryV1GetGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/items": { - "get": { - "tags": [ - "salesOrderItemRepositoryV1" - ], - "description": "Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesOrderItemRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-item-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}": { - "get": { - "tags": [ - "salesInvoiceRepositoryV1" - ], - "description": "Loads a specified invoice.", - "operationId": "salesInvoiceRepositoryV1GetGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The invoice ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices": { - "get": { - "tags": [ - "salesInvoiceRepositoryV1" - ], - "description": "Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesInvoiceRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/": { - "post": { - "tags": [ - "salesInvoiceRepositoryV1" - ], - "description": "Performs persist operations for a specified invoice.", - "operationId": "salesInvoiceRepositoryV1SavePost", - "parameters": [ - { - "name": "salesInvoiceRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "entity" - ], - "properties": { - "entity": { - "$ref": "#/definitions/sales-data-invoice-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/comments": { - "get": { - "tags": [ - "salesInvoiceManagementV1" - ], - "description": "Lists comments for a specified invoice.", - "operationId": "salesInvoiceManagementV1GetCommentsListGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The invoice ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/emails": { - "post": { - "tags": [ - "salesInvoiceManagementV1" - ], - "description": "Emails a user a specified invoice.", - "operationId": "salesInvoiceManagementV1NotifyPost", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The invoice ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/void": { - "post": { - "tags": [ - "salesInvoiceManagementV1" - ], - "description": "Voids a specified invoice.", - "operationId": "salesInvoiceManagementV1SetVoidPost", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The invoice ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/capture": { - "post": { - "tags": [ - "salesInvoiceManagementV1" - ], - "description": "Sets invoice capture.", - "operationId": "salesInvoiceManagementV1SetCapturePost", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/comments": { - "post": { - "tags": [ - "salesInvoiceCommentRepositoryV1" - ], - "description": "Performs persist operations for a specified invoice comment.", - "operationId": "salesInvoiceCommentRepositoryV1SavePost", - "parameters": [ - { - "name": "salesInvoiceCommentRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "entity" - ], - "properties": { - "entity": { - "$ref": "#/definitions/sales-data-invoice-comment-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-comment-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoice/{invoiceId}/refund": { - "post": { - "tags": [ - "salesRefundInvoiceV1" - ], - "description": "Create refund for invoice", - "operationId": "salesRefundInvoiceV1ExecutePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/{id}/comments": { - "get": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "description": "Lists comments for a specified credit memo.", - "operationId": "salesCreditmemoManagementV1GetCommentsListGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The credit memo ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "salesCreditmemoCommentRepositoryV1" - ], - "description": "Performs persist operations for a specified entity.", - "operationId": "salesCreditmemoCommentRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-comment-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/{id}": { - "put": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "description": "Cancels a specified credit memo.", - "operationId": "salesCreditmemoManagementV1CancelPut", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The credit memo ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "salesCreditmemoRepositoryV1" - ], - "description": "Loads a specified credit memo.", - "operationId": "salesCreditmemoRepositoryV1GetGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The credit memo ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/{id}/emails": { - "post": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "description": "Emails a user a specified credit memo.", - "operationId": "salesCreditmemoManagementV1NotifyPost", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The credit memo ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/refund": { - "post": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "description": "Prepare creditmemo to refund and save it.", - "operationId": "salesCreditmemoManagementV1RefundPost", - "parameters": [ - { - "name": "salesCreditmemoManagementV1RefundPostBody", - "in": "body", - "schema": { - "required": [ - "creditmemo" - ], - "properties": { - "creditmemo": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - }, - "offlineRequested": { - "type": "boolean" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemos": { - "get": { - "tags": [ - "salesCreditmemoRepositoryV1" - ], - "description": "Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesCreditmemoRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo": { - "post": { - "tags": [ - "salesCreditmemoRepositoryV1" - ], - "description": "Performs persist operations for a specified credit memo.", - "operationId": "salesCreditmemoRepositoryV1SavePost", - "parameters": [ - { - "name": "salesCreditmemoRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "entity" - ], - "properties": { - "entity": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/order/{orderId}/refund": { - "post": { - "tags": [ - "salesRefundOrderV1" - ], - "description": "Create offline refund for order", - "operationId": "salesRefundOrderV1ExecutePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}": { - "get": { - "tags": [ - "salesShipmentRepositoryV1" - ], - "description": "Loads a specified shipment.", - "operationId": "salesShipmentRepositoryV1GetGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The shipment ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipments": { - "get": { - "tags": [ - "salesShipmentRepositoryV1" - ], - "description": "Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesShipmentRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/": { - "post": { - "tags": [ - "salesShipmentRepositoryV1" - ], - "description": "Performs persist operations for a specified shipment.", - "operationId": "salesShipmentRepositoryV1SavePost", - "parameters": [ - { - "name": "salesShipmentRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "entity" - ], - "properties": { - "entity": { - "$ref": "#/definitions/sales-data-shipment-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}/comments": { - "get": { - "tags": [ - "salesShipmentManagementV1" - ], - "description": "Lists comments for a specified shipment.", - "operationId": "salesShipmentManagementV1GetCommentsListGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The shipment ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "salesShipmentCommentRepositoryV1" - ], - "description": "Performs persist operations for a specified shipment comment.", - "operationId": "salesShipmentCommentRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-comment-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}/emails": { - "post": { - "tags": [ - "salesShipmentManagementV1" - ], - "description": "Emails user a specified shipment.", - "operationId": "salesShipmentManagementV1NotifyPost", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The shipment ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}/label": { - "get": { - "tags": [ - "salesShipmentManagementV1" - ], - "description": "Gets a specified shipment label.", - "operationId": "salesShipmentManagementV1GetLabelGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The shipment label ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Shipment label." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/track": { - "post": { - "tags": [ - "salesShipmentTrackRepositoryV1" - ], - "description": "Performs persist operations for a specified shipment track.", - "operationId": "salesShipmentTrackRepositoryV1SavePost", - "parameters": [ - { - "name": "salesShipmentTrackRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "entity" - ], - "properties": { - "entity": { - "$ref": "#/definitions/sales-data-shipment-track-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-track-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/track/{id}": { - "delete": { - "tags": [ - "salesShipmentTrackRepositoryV1" - ], - "description": "Deletes a specified shipment track by ID.", - "operationId": "salesShipmentTrackRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The shipment track ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/order/{orderId}/ship": { - "post": { - "tags": [ - "salesShipOrderV1" - ], - "description": "Creates new Shipment for given Order.", - "operationId": "salesShipOrderV1ExecutePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Id of created Shipment." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/transactions/{id}": { - "get": { - "tags": [ - "salesTransactionRepositoryV1" - ], - "description": "Loads a specified transaction.", - "operationId": "salesTransactionRepositoryV1GetGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The transaction ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-transaction-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/transactions": { - "get": { - "tags": [ - "salesTransactionRepositoryV1" - ], - "description": "Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesTransactionRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-transaction-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/order/{orderId}/invoice": { - "post": { - "tags": [ - "salesInvoiceOrderV1" - ], - "description": "", - "operationId": "salesInvoiceOrderV1ExecutePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/shipping-information": { - "post": { - "tags": [ - "checkoutGuestShippingInformationManagementV1" - ], - "description": "", - "operationId": "checkoutGuestShippingInformationManagementV1SaveAddressInformationPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/shipping-information": { - "post": { - "tags": [ - "checkoutShippingInformationManagementV1" - ], - "description": "", - "operationId": "checkoutShippingInformationManagementV1SaveAddressInformationPost", - "parameters": [ - { - "name": "checkoutShippingInformationManagementV1SaveAddressInformationPostBody", - "in": "body", - "schema": { - "required": [ - "addressInformation" - ], - "properties": { - "addressInformation": { - "$ref": "#/definitions/checkout-data-shipping-information-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/shipping-information": { - "post": { - "tags": [ - "checkoutShippingInformationManagementV1" - ], - "description": "", - "operationId": "checkoutShippingInformationManagementV1SaveAddressInformationPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/totals-information": { - "post": { - "tags": [ - "checkoutTotalsInformationManagementV1" - ], - "description": "Calculate quote totals based on address and shipping method.", - "operationId": "checkoutTotalsInformationManagementV1CalculatePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/totals-information": { - "post": { - "tags": [ - "checkoutTotalsInformationManagementV1" - ], - "description": "Calculate quote totals based on address and shipping method.", - "operationId": "checkoutTotalsInformationManagementV1CalculatePost", - "parameters": [ - { - "name": "checkoutTotalsInformationManagementV1CalculatePostBody", - "in": "body", - "schema": { - "required": [ - "addressInformation" - ], - "properties": { - "addressInformation": { - "$ref": "#/definitions/checkout-data-totals-information-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/totals-information": { - "post": { - "tags": [ - "checkoutGuestTotalsInformationManagementV1" - ], - "description": "Calculate quote totals based on address and shipping method.", - "operationId": "checkoutGuestTotalsInformationManagementV1CalculatePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/payment-information": { - "post": { - "tags": [ - "checkoutGuestPaymentInformationManagementV1" - ], - "description": "Set payment information and place order for a specified cart.", - "operationId": "checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "checkoutGuestPaymentInformationManagementV1" - ], - "description": "Get payment information", - "operationId": "checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/set-payment-information": { - "post": { - "tags": [ - "checkoutGuestPaymentInformationManagementV1" - ], - "description": "Set payment information for a specified cart.", - "operationId": "checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/payment-information": { - "post": { - "tags": [ - "checkoutPaymentInformationManagementV1" - ], - "description": "Set payment information and place order for a specified cart.", - "operationId": "checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "checkoutPaymentInformationManagementV1" - ], - "description": "Get payment information", - "operationId": "checkoutPaymentInformationManagementV1GetPaymentInformationGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/set-payment-information": { - "post": { - "tags": [ - "checkoutPaymentInformationManagementV1" - ], - "description": "Set payment information for a specified cart.", - "operationId": "checkoutPaymentInformationManagementV1SavePaymentInformationPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/salesRules/{ruleId}": { - "get": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "description": "Get rule by ID.", - "operationId": "salesRuleRuleRepositoryV1GetByIdGet", - "parameters": [ - { - "name": "ruleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "description": "Save sales rule.", - "operationId": "salesRuleRuleRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "description": "Delete rule by ID.", - "operationId": "salesRuleRuleRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "ruleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/salesRules/search": { - "get": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "description": "Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesRuleRuleRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/salesRules": { - "post": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "description": "Save sales rule.", - "operationId": "salesRuleRuleRepositoryV1SavePost", - "parameters": [ - { - "name": "salesRuleRuleRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "rule" - ], - "properties": { - "rule": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/{couponId}": { - "get": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "description": "Get coupon by coupon id.", - "operationId": "salesRuleCouponRepositoryV1GetByIdGet", - "parameters": [ - { - "name": "couponId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "description": "Save a coupon.", - "operationId": "salesRuleCouponRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "description": "Delete coupon by coupon id.", - "operationId": "salesRuleCouponRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "couponId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/search": { - "get": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "description": "Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesRuleCouponRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons": { - "post": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "description": "Save a coupon.", - "operationId": "salesRuleCouponRepositoryV1SavePost", - "parameters": [ - { - "name": "salesRuleCouponRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "coupon" - ], - "properties": { - "coupon": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/generate": { - "post": { - "tags": [ - "salesRuleCouponManagementV1" - ], - "description": "Generate coupon for a rule", - "operationId": "salesRuleCouponManagementV1GeneratePost", - "parameters": [ - { - "name": "salesRuleCouponManagementV1GeneratePostBody", - "in": "body", - "schema": { - "required": [ - "couponSpec" - ], - "properties": { - "couponSpec": { - "$ref": "#/definitions/sales-rule-data-coupon-generation-spec-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/deleteByIds": { - "post": { - "tags": [ - "salesRuleCouponManagementV1" - ], - "description": "Delete coupon by coupon ids.", - "operationId": "salesRuleCouponManagementV1DeleteByIdsPost", - "parameters": [ - { - "name": "salesRuleCouponManagementV1DeleteByIdsPostBody", - "in": "body", - "schema": { - "required": [ - "ids" - ], - "properties": { - "ids": { - "type": "array", - "items": { - "type": "integer" - } - }, - "ignoreInvalidCoupons": { - "type": "boolean" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/deleteByCodes": { - "post": { - "tags": [ - "salesRuleCouponManagementV1" - ], - "description": "Delete coupon by coupon codes.", - "operationId": "salesRuleCouponManagementV1DeleteByCodesPost", - "parameters": [ - { - "name": "salesRuleCouponManagementV1DeleteByCodesPostBody", - "in": "body", - "schema": { - "required": [ - "codes" - ], - "properties": { - "codes": { - "type": "array", - "items": { - "type": "string" - } - }, - "ignoreInvalidCoupons": { - "type": "boolean" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/children": { - "get": { - "tags": [ - "configurableProductLinkManagementV1" - ], - "description": "Get all children for Configurable product", - "operationId": "configurableProductLinkManagementV1GetChildrenGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/children/{childSku}": { - "delete": { - "tags": [ - "configurableProductLinkManagementV1" - ], - "description": "Remove configurable product option", - "operationId": "configurableProductLinkManagementV1RemoveChildDelete", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "childSku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/child": { - "post": { - "tags": [ - "configurableProductLinkManagementV1" - ], - "description": "", - "operationId": "configurableProductLinkManagementV1AddChildPost", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "configurableProductLinkManagementV1AddChildPostBody", - "in": "body", - "schema": { - "required": [ - "childSku" - ], - "properties": { - "childSku": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/variation": { - "put": { - "tags": [ - "configurableProductConfigurableProductManagementV1" - ], - "description": "Generate variation based on same product", - "operationId": "configurableProductConfigurableProductManagementV1GenerateVariationPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/options/{id}": { - "get": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "description": "Get option for configurable product", - "operationId": "configurableProductOptionRepositoryV1GetGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/configurable-product-data-option-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "description": "Save option", - "operationId": "configurableProductOptionRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "description": "Remove option from configurable product", - "operationId": "configurableProductOptionRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/options/all": { - "get": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "description": "Get all options for configurable product", - "operationId": "configurableProductOptionRepositoryV1GetListGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/configurable-product-data-option-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/options": { - "post": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "description": "Save option", - "operationId": "configurableProductOptionRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links": { - "get": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "description": "List of links with associated samples", - "operationId": "downloadableLinkRepositoryV1GetListGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/downloadable-data-link-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "description": "Update downloadable link of the given product (link type and its resources cannot be changed)", - "operationId": "downloadableLinkRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links/{id}": { - "put": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "description": "Update downloadable link of the given product (link type and its resources cannot be changed)", - "operationId": "downloadableLinkRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/downloadable-links/{id}": { - "delete": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "description": "Delete downloadable link", - "operationId": "downloadableLinkRepositoryV1DeleteDelete", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links/samples": { - "get": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "description": "List of samples for downloadable product", - "operationId": "downloadableSampleRepositoryV1GetListGet", - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/downloadable-data-sample-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "description": "Update downloadable sample of the given product", - "operationId": "downloadableSampleRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links/samples/{id}": { - "put": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "description": "Update downloadable sample of the given product", - "operationId": "downloadableSampleRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/downloadable-links/samples/{id}": { - "delete": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "description": "Delete downloadable sample", - "operationId": "downloadableSampleRepositoryV1DeleteDelete", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/licence": { - "get": { - "tags": [ - "checkoutAgreementsCheckoutAgreementsRepositoryV1" - ], - "description": "Lists active checkout agreements.", - "operationId": "checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/checkout-agreements-data-agreement-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRates": { - "post": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "description": "Create or update tax rate", - "operationId": "taxTaxRateRepositoryV1SavePost", - "parameters": [ - { - "name": "taxTaxRateRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "taxRate" - ], - "properties": { - "taxRate": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "description": "Create or update tax rate", - "operationId": "taxTaxRateRepositoryV1SavePut", - "parameters": [ - { - "name": "taxTaxRateRepositoryV1SavePutBody", - "in": "body", - "schema": { - "required": [ - "taxRate" - ], - "properties": { - "taxRate": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRates/{rateId}": { - "get": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "description": "Get tax rate", - "operationId": "taxTaxRateRepositoryV1GetGet", - "parameters": [ - { - "name": "rateId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "description": "Delete tax rate", - "operationId": "taxTaxRateRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "rateId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRates/search": { - "get": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "description": "Search TaxRates This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "taxTaxRateRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-search-results-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRules": { - "post": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "description": "Save TaxRule", - "operationId": "taxTaxRuleRepositoryV1SavePost", - "parameters": [ - { - "name": "taxTaxRuleRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "rule" - ], - "properties": { - "rule": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "description": "Save TaxRule", - "operationId": "taxTaxRuleRepositoryV1SavePut", - "parameters": [ - { - "name": "taxTaxRuleRepositoryV1SavePutBody", - "in": "body", - "schema": { - "required": [ - "rule" - ], - "properties": { - "rule": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRules/{ruleId}": { - "delete": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "description": "Delete TaxRule", - "operationId": "taxTaxRuleRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "ruleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "description": "Get TaxRule", - "operationId": "taxTaxRuleRepositoryV1GetGet", - "parameters": [ - { - "name": "ruleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRules/search": { - "get": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "description": "Search TaxRules This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "taxTaxRuleRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-search-results-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses": { - "post": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "description": "Create a Tax Class", - "operationId": "taxTaxClassRepositoryV1SavePost", - "parameters": [ - { - "name": "taxTaxClassRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "taxClass" - ], - "properties": { - "taxClass": { - "$ref": "#/definitions/tax-data-tax-class-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "id for the newly created Tax class" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses/{taxClassId}": { - "get": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "description": "Get a tax class with the given tax class id.", - "operationId": "taxTaxClassRepositoryV1GetGet", - "parameters": [ - { - "name": "taxClassId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-class-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "description": "Delete a tax class with the given tax class id.", - "operationId": "taxTaxClassRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "taxClassId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "True if the tax class was deleted, false otherwise" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses/{classId}": { - "put": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "description": "Create a Tax Class", - "operationId": "taxTaxClassRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "id for the newly created Tax class" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses/search": { - "get": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "description": "Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "taxTaxClassRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-class-search-results-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/": { - "get": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "description": "Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included.", - "operationId": "companyCompanyRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "description": "Create or update a company account.", - "operationId": "companyCompanyRepositoryV1SavePost", - "parameters": [ - { - "name": "companyCompanyRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "company" - ], - "properties": { - "company": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/{companyId}": { - "get": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "description": "Returns company details.", - "operationId": "companyCompanyRepositoryV1GetGet", - "parameters": [ - { - "name": "companyId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "description": "Delete a company. Customers belonging to a company are not deleted with this request.", - "operationId": "companyCompanyRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "companyId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "description": "Create or update a company account.", - "operationId": "companyCompanyRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/team/": { - "get": { - "tags": [ - "companyTeamRepositoryV1" - ], - "description": "Returns the list of teams for the specified search criteria (team name or description).", - "operationId": "companyTeamRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-team-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/team/{teamId}": { - "get": { - "tags": [ - "companyTeamRepositoryV1" - ], - "description": "Returns data for a team in the company, by entity id.", - "operationId": "companyTeamRepositoryV1GetGet", - "parameters": [ - { - "name": "teamId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-team-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "companyTeamRepositoryV1" - ], - "description": "Delete a team from the company structure.", - "operationId": "companyTeamRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "teamId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "companyTeamRepositoryV1" - ], - "description": "Update a team in the company structure.", - "operationId": "companyTeamRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/team/{companyId}": { - "post": { - "tags": [ - "companyTeamRepositoryV1" - ], - "description": "Create a team in the company structure.", - "operationId": "companyTeamRepositoryV1CreatePost", - "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" - } - } - ], - "responses": { - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/hierarchy/{id}": { - "get": { - "tags": [ - "companyCompanyHierarchyV1" - ], - "description": "Returns the list of teams and company users in the company structure.", - "operationId": "companyCompanyHierarchyV1GetCompanyHierarchyGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/company-data-hierarchy-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/hierarchy/move/{id}": { - "put": { - "tags": [ - "companyCompanyHierarchyV1" - ], - "description": "Moves teams and users within the company structure.", - "operationId": "companyCompanyHierarchyV1MoveNodePut", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "companyCompanyHierarchyV1MoveNodePutBody", - "in": "body", - "schema": { - "required": [ - "newParentId" - ], - "properties": { - "newParentId": { - "type": "integer" - } - }, - "type": "object" - } - } - ], - "responses": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/role/": { - "get": { - "tags": [ - "companyRoleRepositoryV1" - ], - "description": "Returns the list of roles and permissions for a specified company.", - "operationId": "companyRoleRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "companyRoleRepositoryV1" - ], - "description": "Create or update a role for a selected company.", - "operationId": "companyRoleRepositoryV1SavePost", - "parameters": [ - { - "name": "companyRoleRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "role" - ], - "properties": { - "role": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/role/{roleId}": { - "get": { - "tags": [ - "companyRoleRepositoryV1" - ], - "description": "Returns the list of permissions for a specified role.", - "operationId": "companyRoleRepositoryV1GetGet", - "parameters": [ - { - "name": "roleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "companyRoleRepositoryV1" - ], - "description": "Delete a role.", - "operationId": "companyRoleRepositoryV1DeleteDelete", - "parameters": [ - { - "name": "roleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/role/{id}": { - "put": { - "tags": [ - "companyRoleRepositoryV1" - ], - "description": "Create or update a role for a selected company.", - "operationId": "companyRoleRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/assignRoles": { - "put": { - "tags": [ - "companyAclV1" - ], - "description": "Change a role for a company user.", - "operationId": "companyAclV1AssignRolesPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/role/{roleId}/users": { - "get": { - "tags": [ - "companyAclV1" - ], - "description": "View the list of company users assigned to a specified role.", - "operationId": "companyAclV1GetUsersByRoleIdGet", - "parameters": [ - { - "name": "roleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-customer-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/integration/admin/token": { - "post": { - "tags": [ - "integrationAdminTokenServiceV1" - ], - "description": "Create access token for admin given the admin credentials.", - "operationId": "integrationAdminTokenServiceV1CreateAdminAccessTokenPost", - "parameters": [ - { - "name": "integrationAdminTokenServiceV1CreateAdminAccessTokenPostBody", - "in": "body", - "schema": { - "required": [ - "username", - "password" - ], - "properties": { - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Token created" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/integration/customer/token": { - "post": { - "tags": [ - "integrationCustomerTokenServiceV1" - ], - "description": "Create access token for admin given the customer credentials.", - "operationId": "integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost", - "parameters": [ - { - "name": "integrationCustomerTokenServiceV1CreateCustomerAccessTokenPostBody", - "in": "body", - "schema": { - "required": [ - "username", - "password" - ], - "properties": { - "username": { - "type": "string" - }, - "password": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Token created" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/analytics/link": { - "get": { - "tags": [ - "analyticsLinkProviderV1" - ], - "description": "", - "operationId": "analyticsLinkProviderV1GetGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/analytics-data-link-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/balance/apply": { - "post": { - "tags": [ - "customerBalanceBalanceManagementFromQuoteV1" - ], - "description": "Apply store credit.", - "operationId": "customerBalanceBalanceManagementFromQuoteV1ApplyPost", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/balance/unapply": { - "post": { - "tags": [ - "customerBalanceBalanceManagementFromQuoteV1" - ], - "description": "Unapply store credit.", - "operationId": "customerBalanceBalanceManagementFromQuoteV1UnapplyPost", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/request": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuoteManagementV1" - ], - "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", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/submitToCustomer": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuoteManagementV1" - ], - "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", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/decline": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuoteManagementV1" - ], - "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", - "parameters": [ - { - "name": "negotiableQuoteNegotiableQuoteManagementV1DeclinePostBody", - "in": "body", - "schema": { - "required": [ - "quoteId", - "reason" - ], - "properties": { - "quoteId": { - "type": "integer" - }, - "reason": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/pricesUpdated": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuotePriceManagementV1" - ], - "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", - "parameters": [ - { - "name": "negotiableQuoteNegotiableQuotePriceManagementV1PricesUpdatedPostBody", - "in": "body", - "schema": { - "required": [ - "quoteIds" - ], - "properties": { - "quoteIds": { - "type": "array", - "items": { - "type": "integer" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/attachmentContent": { - "get": { - "tags": [ - "negotiableQuoteAttachmentContentManagementV1" - ], - "description": "Returns content for one or more files attached on the quote comment.", - "operationId": "negotiableQuoteAttachmentContentManagementV1GetGet", - "parameters": [ - { - "name": "attachmentIds", - "in": "query", - "type": "array", - "items": { - "type": "integer" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/{quoteId}/comments": { - "get": { - "tags": [ - "negotiableQuoteCommentLocatorV1" - ], - "description": "Returns comments for a specified negotiable quote.", - "operationId": "negotiableQuoteCommentLocatorV1GetListForQuoteGet", - "parameters": [ - { - "name": "quoteId", - "in": "path", - "type": "integer", - "required": true, - "description": "Negotiable Quote ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of quote comments.", - "items": { - "$ref": "#/definitions/negotiable-quote-data-comment-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/{quoteId}/shippingMethod": { - "put": { - "tags": [ - "negotiableQuoteNegotiableQuoteShippingManagementV1" - ], - "description": "Updates the shipping method on a negotiable quote.", - "operationId": "negotiableQuoteNegotiableQuoteShippingManagementV1SetShippingMethodPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/payment-information": { - "post": { - "tags": [ - "negotiableQuotePaymentInformationManagementV1" - ], - "description": "Set payment information and place order for a specified cart.", - "operationId": "negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "negotiableQuotePaymentInformationManagementV1" - ], - "description": "Get payment information", - "operationId": "negotiableQuotePaymentInformationManagementV1GetPaymentInformationGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/set-payment-information": { - "post": { - "tags": [ - "negotiableQuotePaymentInformationManagementV1" - ], - "description": "Set payment information for a specified cart.", - "operationId": "negotiableQuotePaymentInformationManagementV1SavePaymentInformationPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/shipping-information": { - "post": { - "tags": [ - "negotiableQuoteShippingInformationManagementV1" - ], - "description": "", - "operationId": "negotiableQuoteShippingInformationManagementV1SaveAddressInformationPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "negotiableQuoteShipmentEstimationV1" - ], - "description": "Estimate shipping by address and return list of available shipping methods", - "operationId": "negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id": { - "post": { - "tags": [ - "negotiableQuoteShippingMethodManagementV1" - ], - "description": "Estimate shipping", - "operationId": "negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/{quoteId}": { - "put": { - "tags": [ - "negotiableQuoteNegotiableCartRepositoryV1" - ], - "description": "Save quote", - "operationId": "negotiableQuoteNegotiableCartRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/billing-address": { - "get": { - "tags": [ - "negotiableQuoteBillingAddressManagementV1" - ], - "description": "Returns the billing address for a specified quote.", - "operationId": "negotiableQuoteBillingAddressManagementV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "negotiableQuoteBillingAddressManagementV1" - ], - "description": "Assigns a specified billing address to a specified cart.", - "operationId": "negotiableQuoteBillingAddressManagementV1AssignPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/totals": { - "get": { - "tags": [ - "negotiableQuoteCartTotalRepositoryV1" - ], - "description": "Returns quote totals data for a specified cart.", - "operationId": "negotiableQuoteCartTotalRepositoryV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/coupons/{couponCode}": { - "put": { - "tags": [ - "negotiableQuoteCouponManagementV1" - ], - "description": "Adds a coupon by code to a specified cart.", - "operationId": "negotiableQuoteCouponManagementV1SetPut", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/coupons": { - "delete": { - "tags": [ - "negotiableQuoteCouponManagementV1" - ], - "description": "Deletes a coupon from a specified cart.", - "operationId": "negotiableQuoteCouponManagementV1RemoveDelete", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/giftCards": { - "post": { - "tags": [ - "negotiableQuoteGiftCardAccountManagementV1" - ], - "description": "", - "operationId": "negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "negotiableQuoteGiftCardAccountManagementV1" - ], - "description": "Remove GiftCard Account entity", - "operationId": "negotiableQuoteGiftCardAccountManagementV1DeleteByQuoteIdDelete", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "giftCardCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{quoteId}/giftCards": { - "get": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "Return GiftCard Account cards", - "operationId": "giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet", - "parameters": [ - { - "name": "quoteId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/giftCards": { - "put": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "", - "operationId": "giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "Remove GiftCard Account entity", - "operationId": "giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "giftCardCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "Remove GiftCard Account entity", - "operationId": "giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete", - "parameters": [ - { - "name": "giftCardCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/giftCards": { - "post": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "", - "operationId": "giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost", - "parameters": [ - { - "name": "giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPostBody", - "in": "body", - "schema": { - "required": [ - "giftCardAccountData" - ], - "properties": { - "giftCardAccountData": { - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/checkGiftCard/{giftCardCode}": { - "get": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "", - "operationId": "giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet", - "parameters": [ - { - "name": "giftCardCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "number" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "giftCardAccountGuestGiftCardAccountManagementV1" - ], - "description": "Remove GiftCard Account entity", - "operationId": "giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "giftCardCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/guest-carts/{cartId}/giftCards": { - "post": { - "tags": [ - "giftCardAccountGuestGiftCardAccountManagementV1" - ], - "description": "", - "operationId": "giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}": { - "get": { - "tags": [ - "giftCardAccountGuestGiftCardAccountManagementV1" - ], - "description": "", - "operationId": "giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "giftCardCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "number" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}": { - "get": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "description": "Return the following properties for the selected shared catalog: ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.", - "operationId": "sharedCatalogSharedCatalogRepositoryV1GetGet", - "parameters": [ - { - "name": "sharedCatalogId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "description": "Delete a shared catalog by ID.", - "operationId": "sharedCatalogSharedCatalogRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "sharedCatalogId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog": { - "post": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "description": "Create or update Shared Catalog service.", - "operationId": "sharedCatalogSharedCatalogRepositoryV1SavePost", - "parameters": [ - { - "name": "sharedCatalogSharedCatalogRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "sharedCatalog" - ], - "properties": { - "sharedCatalog": { - "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}": { - "put": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "description": "Create or update Shared Catalog service.", - "operationId": "sharedCatalogSharedCatalogRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/": { - "get": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "description": "Return the list of shared catalogs and basic properties for each catalog.", - "operationId": "sharedCatalogSharedCatalogRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/shared-catalog-data-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}/companies": { - "get": { - "tags": [ - "sharedCatalogCompanyManagementV1" - ], - "description": "Return the list of company IDs for the companies assigned to the selected catalog.", - "operationId": "sharedCatalogCompanyManagementV1GetCompaniesGet", - "parameters": [ - { - "name": "sharedCatalogId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}/assignCompanies": { - "post": { - "tags": [ - "sharedCatalogCompanyManagementV1" - ], - "description": "Assign companies to a shared catalog.", - "operationId": "sharedCatalogCompanyManagementV1AssignCompaniesPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}/unassignCompanies": { - "post": { - "tags": [ - "sharedCatalogCompanyManagementV1" - ], - "description": "Unassign companies from a shared catalog.", - "operationId": "sharedCatalogCompanyManagementV1UnassignCompaniesPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/products": { - "get": { - "tags": [ - "sharedCatalogProductManagementV1" - ], - "description": "Return the list of product SKUs in the selected shared catalog.", - "operationId": "sharedCatalogProductManagementV1GetProductsGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/assignProducts": { - "post": { - "tags": [ - "sharedCatalogProductManagementV1" - ], - "description": "Add products into the shared catalog.", - "operationId": "sharedCatalogProductManagementV1AssignProductsPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/unassignProducts": { - "post": { - "tags": [ - "sharedCatalogProductManagementV1" - ], - "description": "Remove the specified products from the shared catalog.", - "operationId": "sharedCatalogProductManagementV1UnassignProductsPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/categories": { - "get": { - "tags": [ - "sharedCatalogCategoryManagementV1" - ], - "description": "Return the list of categories in the selected shared catalog.", - "operationId": "sharedCatalogCategoryManagementV1GetCategoriesGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "integer" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/assignCategories": { - "post": { - "tags": [ - "sharedCatalogCategoryManagementV1" - ], - "description": "Add categories into the shared catalog.", - "operationId": "sharedCatalogCategoryManagementV1AssignCategoriesPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/unassignCategories": { - "post": { - "tags": [ - "sharedCatalogCategoryManagementV1" - ], - "description": "Remove the specified categories from the shared catalog.", - "operationId": "sharedCatalogCategoryManagementV1UnassignCategoriesPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/gift-message": { - "get": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "description": "Return the gift message for a specified order.", - "operationId": "giftMessageCartRepositoryV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "description": "Set the gift message for an entire order.", - "operationId": "giftMessageCartRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/gift-message": { - "get": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "description": "Return the gift message for a specified order.", - "operationId": "giftMessageCartRepositoryV1GetGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "description": "Set the gift message for an entire order.", - "operationId": "giftMessageCartRepositoryV1SavePost", - "parameters": [ - { - "name": "giftMessageCartRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "giftMessage" - ], - "properties": { - "giftMessage": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/gift-message/{itemId}": { - "get": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "description": "Return the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageItemRepositoryV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The shopping cart ID." - }, - { - "name": "itemId", - "in": "path", - "type": "integer", - "required": true, - "description": "The item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "description": "Set the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageItemRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/gift-message/{itemId}": { - "get": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "description": "Return the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageItemRepositoryV1GetGet", - "parameters": [ - { - "name": "itemId", - "in": "path", - "type": "integer", - "required": true, - "description": "The item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "description": "Set the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageItemRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/gift-message": { - "get": { - "tags": [ - "giftMessageGuestCartRepositoryV1" - ], - "description": "Return the gift message for a specified order.", - "operationId": "giftMessageGuestCartRepositoryV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageGuestCartRepositoryV1" - ], - "description": "Set the gift message for an entire order.", - "operationId": "giftMessageGuestCartRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/gift-message/{itemId}": { - "get": { - "tags": [ - "giftMessageGuestItemRepositoryV1" - ], - "description": "Return the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageGuestItemRepositoryV1GetGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The shopping cart ID." - }, - { - "name": "itemId", - "in": "path", - "type": "integer", - "required": true, - "description": "The item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageGuestItemRepositoryV1" - ], - "description": "Set the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageGuestItemRepositoryV1SavePost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/giftregistry/mine/estimate-shipping-methods": { - "post": { - "tags": [ - "giftRegistryShippingMethodManagementV1" - ], - "description": "Estimate shipping", - "operationId": "giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost", - "parameters": [ - { - "name": "giftRegistryShippingMethodManagementV1EstimateByRegistryIdPostBody", - "in": "body", - "schema": { - "required": [ - "registryId" - ], - "properties": { - "registryId": { - "type": "integer", - "description": "The estimate registry id" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "giftRegistryGuestCartShippingMethodManagementV1" - ], - "description": "Estimate shipping", - "operationId": "giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/gift-wrappings/{id}": { - "get": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "description": "Return data object for specified wrapping ID and store.", - "operationId": "giftWrappingWrappingRepositoryV1GetGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "description": "Delete gift wrapping", - "operationId": "giftWrappingWrappingRepositoryV1DeleteByIdDelete", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/gift-wrappings": { - "post": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "description": "Create/Update new gift wrapping with data object values", - "operationId": "giftWrappingWrappingRepositoryV1SavePost", - "parameters": [ - { - "name": "giftWrappingWrappingRepositoryV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - }, - "storeId": { - "type": "integer" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "description": "Return list of gift wrapping data objects based on search criteria", - "operationId": "giftWrappingWrappingRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/gift-wrappings/{wrappingId}": { - "put": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "description": "Create/Update new gift wrapping with data object values", - "operationId": "giftWrappingWrappingRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/reward/mine/use-reward": { - "post": { - "tags": [ - "rewardRewardManagementV1" - ], - "description": "Set reward points to quote", - "operationId": "rewardRewardManagementV1SetPost", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/tracking-numbers": { - "post": { - "tags": [ - "rmaTrackManagementV1" - ], - "description": "Add track", - "operationId": "rmaTrackManagementV1AddTrackPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "rmaTrackManagementV1" - ], - "description": "Get track list", - "operationId": "rmaTrackManagementV1GetTracksGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-track-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/tracking-numbers/{trackId}": { - "delete": { - "tags": [ - "rmaTrackManagementV1" - ], - "description": "Remove track by id", - "operationId": "rmaTrackManagementV1RemoveTrackByIdDelete", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "trackId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/labels": { - "get": { - "tags": [ - "rmaTrackManagementV1" - ], - "description": "Get shipping label int the PDF format", - "operationId": "rmaTrackManagementV1GetShippingLabelPdfGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}": { - "get": { - "tags": [ - "rmaRmaRepositoryV1" - ], - "description": "Return data object for specified RMA id", - "operationId": "rmaRmaRepositoryV1GetGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "rmaRmaRepositoryV1" - ], - "description": "Delete RMA", - "operationId": "rmaRmaRepositoryV1DeleteDelete", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "rmaRmaManagementV1" - ], - "description": "Save RMA", - "operationId": "rmaRmaManagementV1SaveRmaPut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/comments": { - "post": { - "tags": [ - "rmaCommentManagementV1" - ], - "description": "Add comment", - "operationId": "rmaCommentManagementV1AddCommentPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "rmaCommentManagementV1" - ], - "description": "Comments list", - "operationId": "rmaCommentManagementV1CommentsListGet", - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns": { - "post": { - "tags": [ - "rmaRmaManagementV1" - ], - "description": "Save RMA", - "operationId": "rmaRmaManagementV1SaveRmaPost", - "parameters": [ - { - "name": "rmaRmaManagementV1SaveRmaPostBody", - "in": "body", - "schema": { - "required": [ - "rmaDataObject" - ], - "properties": { - "rmaDataObject": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "rmaRmaManagementV1" - ], - "description": "Return list of rma data objects based on search criteria", - "operationId": "rmaRmaManagementV1SearchGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata/{attributeCode}": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Retrieve attribute metadata.", - "operationId": "rmaRmaAttributesManagementV1GetAttributeMetadataGet", - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata/form/{formCode}": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Retrieve all attributes filtered by form code", - "operationId": "rmaRmaAttributesManagementV1GetAttributesGet", - "parameters": [ - { - "name": "formCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Get all attribute metadata.", - "operationId": "rmaRmaAttributesManagementV1GetAllAttributesMetadataGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata/custom": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Get custom attribute metadata for the given Data object's attribute set", - "operationId": "rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet", - "parameters": [ - { - "name": "dataObjectClassName", - "in": "query", - "type": "string", - "description": "Data object class name", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-metadata-object-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/": { - "get": { - "tags": [ - "companyCreditCreditLimitRepositoryV1" - ], - "description": "Returns the list of credits for specified companies.", - "operationId": "companyCreditCreditLimitRepositoryV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{creditId}": { - "get": { - "tags": [ - "companyCreditCreditLimitRepositoryV1" - ], - "description": "Returns data on the credit limit for a specified credit limit ID.", - "operationId": "companyCreditCreditLimitRepositoryV1GetGet", - "parameters": [ - { - "name": "creditId", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "reload", - "in": "query", - "type": "boolean", - "description": "[optional]", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{id}": { - "put": { - "tags": [ - "companyCreditCreditLimitRepositoryV1" - ], - "description": "Update the following company credit attributes: credit currency, credit limit and setting to exceed credit.", - "operationId": "companyCreditCreditLimitRepositoryV1SavePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/company/{companyId}": { - "get": { - "tags": [ - "companyCreditCreditLimitManagementV1" - ], - "description": "Returns data on the credit limit for a specified company.", - "operationId": "companyCreditCreditLimitManagementV1GetCreditByCompanyIdGet", - "parameters": [ - { - "name": "companyId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{creditId}/increaseBalance": { - "post": { - "tags": [ - "companyCreditCreditBalanceManagementV1" - ], - "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", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{creditId}/decreaseBalance": { - "post": { - "tags": [ - "companyCreditCreditBalanceManagementV1" - ], - "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", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/history": { - "get": { - "tags": [ - "companyCreditCreditHistoryManagementV1" - ], - "description": "Returns the credit history for one or more companies.", - "operationId": "companyCreditCreditHistoryManagementV1GetListGet", - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-history-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/history/{historyId}": { - "put": { - "tags": [ - "companyCreditCreditHistoryManagementV1" - ], - "description": "Update the PO Number and/or comment for a Reimburse transaction.", - "operationId": "companyCreditCreditHistoryManagementV1UpdatePut", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bulk/{bulkUuid}/detailed-status": { - "get": { - "tags": [ - "asynchronousOperationsBulkStatusV1" - ], - "description": "Get Bulk summary data with list of operations items full data.", - "operationId": "asynchronousOperationsBulkStatusV1GetBulkDetailedStatusGet", - "parameters": [ - { - "name": "bulkUuid", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/asynchronous-operations-data-detailed-bulk-operations-status-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bulk/{bulkUuid}/status": { - "get": { - "tags": [ - "asynchronousOperationsBulkStatusV1" - ], - "description": "Get Bulk summary data with list of operations items short data.", - "operationId": "asynchronousOperationsBulkStatusV1GetBulkShortStatusGet", - "parameters": [ - { - "name": "bulkUuid", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/asynchronous-operations-data-bulk-operations-status-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bulk/{bulkUuid}/operation-status/{status}": { - "get": { - "tags": [ - "asynchronousOperationsBulkStatusV1" - ], - "description": "Get operations count by bulk uuid and status.", - "operationId": "asynchronousOperationsBulkStatusV1GetOperationsCountByBulkIdAndStatusGet", - "parameters": [ - { - "name": "bulkUuid", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "status", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/worldpay-guest-carts/{cartId}/payment-information": { - "post": { - "tags": [ - "worldpayGuestPaymentInformationManagementProxyV1" - ], - "description": "Proxy handler for guest place order", - "operationId": "worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost", - "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" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/amazon-shipping-address/{amazonOrderReferenceId}": { - "put": { - "tags": [ - "amazonPaymentAddressManagementV1" - ], - "description": "", - "operationId": "amazonPaymentAddressManagementV1GetShippingAddressPut", - "parameters": [ - { - "name": "amazonOrderReferenceId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "amazonPaymentAddressManagementV1GetShippingAddressPutBody", - "in": "body", - "schema": { - "required": [ - "addressConsentToken" - ], - "properties": { - "addressConsentToken": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/amazon-billing-address/{amazonOrderReferenceId}": { - "put": { - "tags": [ - "amazonPaymentAddressManagementV1" - ], - "description": "", - "operationId": "amazonPaymentAddressManagementV1GetBillingAddressPut", - "parameters": [ - { - "name": "amazonOrderReferenceId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "amazonPaymentAddressManagementV1GetBillingAddressPutBody", - "in": "body", - "schema": { - "required": [ - "addressConsentToken" - ], - "properties": { - "addressConsentToken": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/amazon/order-ref": { - "delete": { - "tags": [ - "amazonPaymentOrderInformationManagementV1" - ], - "description": "", - "operationId": "amazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete", - "responses": { - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/delivery-option": { - "post": { - "tags": [ - "temandoShippingQuoteCartDeliveryOptionManagementV1" - ], - "description": "Handle selected delivery option.", - "operationId": "temandoShippingQuoteCartDeliveryOptionManagementV1SavePost", - "parameters": [ - { - "name": "temandoShippingQuoteCartDeliveryOptionManagementV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "selectedOption" - ], - "properties": { - "selectedOption": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/delivery-option": { - "post": { - "tags": [ - "temandoShippingQuoteGuestCartDeliveryOptionManagementV1" - ], - "description": "Handle selected delivery option.", - "operationId": "temandoShippingQuoteGuestCartDeliveryOptionManagementV1SavePost", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The shopping cart ID." - }, - { - "name": "temandoShippingQuoteGuestCartDeliveryOptionManagementV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "selectedOption" - ], - "properties": { - "selectedOption": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/temando/rma/{rmaId}/shipments": { - "put": { - "tags": [ - "temandoShippingRmaRmaShipmentManagementV1" - ], - "description": "Assign platform shipment IDs to a core RMA entity.", - "operationId": "temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPut", - "parameters": [ - { - "name": "rmaId", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPutBody", - "in": "body", - "schema": { - "required": [ - "returnShipmentIds" - ], - "properties": { - "returnShipmentIds": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Number of successfully assigned shipment IDs." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collection-point/search-request": { - "put": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SaveSearchRequestPut", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SaveSearchRequestPutBody", - "in": "body", - "schema": { - "required": [ - "countryId", - "postcode" - ], - "properties": { - "countryId": { - "type": "string" - }, - "postcode": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/temando-shipping-data-collection-point-search-request-interface" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1DeleteSearchRequestDelete", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collection-point/search-result": { - "get": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1GetCollectionPointsGet", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/temando-shipping-data-collection-point-quote-collection-point-interface" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collection-point/select": { - "post": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SelectCollectionPointPost", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SelectCollectionPointPostBody", - "in": "body", - "schema": { - "required": [ - "entityId" - ], - "properties": { - "entityId": { - "type": "integer" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collection-point/search-request": { - "put": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1SaveSearchRequestPut", - "parameters": [ - { - "name": "temandoShippingCollectionPointCartCollectionPointManagementV1SaveSearchRequestPutBody", - "in": "body", - "schema": { - "required": [ - "countryId", - "postcode" - ], - "properties": { - "countryId": { - "type": "string" - }, - "postcode": { - "type": "string" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/temando-shipping-data-collection-point-search-request-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1DeleteSearchRequestDelete", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collection-point/search-result": { - "get": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1GetCollectionPointsGet", - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/temando-shipping-data-collection-point-quote-collection-point-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collection-point/select": { - "post": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1SelectCollectionPointPost", - "parameters": [ - { - "name": "temandoShippingCollectionPointCartCollectionPointManagementV1SelectCollectionPointPostBody", - "in": "body", - "schema": { - "required": [ - "entityId" - ], - "properties": { - "entityId": { - "type": "integer" - } - }, - "type": "object" - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/checkout-fields": { - "post": { - "tags": [ - "temandoShippingQuoteGuestCartCheckoutFieldManagementV1" - ], - "description": "", - "operationId": "temandoShippingQuoteGuestCartCheckoutFieldManagementV1SaveCheckoutFieldsPost", - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "temandoShippingQuoteGuestCartCheckoutFieldManagementV1SaveCheckoutFieldsPostBody", - "in": "body", - "schema": { - "required": [ - "serviceSelection" - ], - "properties": { - "serviceSelection": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/checkout-fields": { - "post": { - "tags": [ - "temandoShippingQuoteCartCheckoutFieldManagementV1" - ], - "description": "", - "operationId": "temandoShippingQuoteCartCheckoutFieldManagementV1SaveCheckoutFieldsPost", - "parameters": [ - { - "name": "temandoShippingQuoteCartCheckoutFieldManagementV1SaveCheckoutFieldsPostBody", - "in": "body", - "schema": { - "required": [ - "serviceSelection" - ], - "properties": { - "serviceSelection": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - }, - "type": "object" - } - } - ], - "responses": { - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - } - }, - "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" - } - } - }, - "store-data-store-interface": { - "type": "object", - "description": "Store interface", - "properties": { - "id": { - "type": "integer" - }, - "code": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Store name" - }, - "website_id": { - "type": "integer" - }, - "store_group_id": { - "type": "integer" - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-store-extension-interface" - } - }, - "required": [ - "id", - "code", - "name", - "website_id", - "store_group_id" - ] - }, - "store-data-store-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface" - }, - "store-data-group-interface": { - "type": "object", - "description": "Group interface", - "properties": { - "id": { - "type": "integer" - }, - "website_id": { - "type": "integer" - }, - "root_category_id": { - "type": "integer" - }, - "default_store_id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "code": { - "type": "string", - "description": "Group code." - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-group-extension-interface" - } - }, - "required": [ - "id", - "website_id", - "root_category_id", - "default_store_id", - "name", - "code" - ] - }, - "store-data-group-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface" - }, - "store-data-website-interface": { - "type": "object", - "description": "Website interface", - "properties": { - "id": { - "type": "integer" - }, - "code": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Website name" - }, - "default_group_id": { - "type": "integer" - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-website-extension-interface" - } - }, - "required": [ - "id", - "code", - "name", - "default_group_id" - ] - }, - "store-data-website-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface" - }, - "store-data-store-config-interface": { - "type": "object", - "description": "StoreConfig interface", - "properties": { - "id": { - "type": "integer", - "description": "Store id" - }, - "code": { - "type": "string", - "description": "Store code" - }, - "website_id": { - "type": "integer", - "description": "Website id of the store" - }, - "locale": { - "type": "string", - "description": "Store locale" - }, - "base_currency_code": { - "type": "string", - "description": "Base currency code" - }, - "default_display_currency_code": { - "type": "string", - "description": "Default display currency code" - }, - "timezone": { - "type": "string", - "description": "Timezone of the store" - }, - "weight_unit": { - "type": "string", - "description": "The unit of weight" - }, - "base_url": { - "type": "string", - "description": "Base URL for the store" - }, - "base_link_url": { - "type": "string", - "description": "Base link URL for the store" - }, - "base_static_url": { - "type": "string", - "description": "Base static URL for the store" - }, - "base_media_url": { - "type": "string", - "description": "Base media URL for the store" - }, - "secure_base_url": { - "type": "string", - "description": "Secure base URL for the store" - }, - "secure_base_link_url": { - "type": "string", - "description": "Secure base link URL for the store" - }, - "secure_base_static_url": { - "type": "string", - "description": "Secure base static URL for the store" - }, - "secure_base_media_url": { - "type": "string", - "description": "Secure base media URL for the store" - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-store-config-extension-interface" - } - }, - "required": [ - "id", - "code", - "website_id", - "locale", - "base_currency_code", - "default_display_currency_code", - "timezone", - "weight_unit", - "base_url", - "base_link_url", - "base_static_url", - "base_media_url", - "secure_base_url", - "secure_base_link_url", - "secure_base_static_url", - "secure_base_media_url" - ] - }, - "store-data-store-config-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface" - }, - "directory-data-currency-information-interface": { - "type": "object", - "description": "Currency Information interface.", - "properties": { - "base_currency_code": { - "type": "string", - "description": "The base currency code for the store." - }, - "base_currency_symbol": { - "type": "string", - "description": "The currency symbol of the base currency for the store." - }, - "default_display_currency_code": { - "type": "string", - "description": "The default display currency code for the store." - }, - "default_display_currency_symbol": { - "type": "string", - "description": "The currency symbol of the default display currency for the store." - }, - "available_currency_codes": { - "type": "array", - "description": "The list of allowed currency codes for the store.", - "items": { - "type": "string" - } - }, - "exchange_rates": { - "type": "array", - "description": "The list of exchange rate information for the store.", - "items": { - "$ref": "#/definitions/directory-data-exchange-rate-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-currency-information-extension-interface" - } - }, - "required": [ - "base_currency_code", - "base_currency_symbol", - "default_display_currency_code", - "default_display_currency_symbol", - "available_currency_codes", - "exchange_rates" - ] - }, - "directory-data-exchange-rate-interface": { - "type": "object", - "description": "Exchange Rate interface.", - "properties": { - "currency_to": { - "type": "string", - "description": "The currency code associated with the exchange rate." - }, - "rate": { - "type": "number", - "description": "The exchange rate for the associated currency and the store's base currency." - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-exchange-rate-extension-interface" - } - }, - "required": [ - "currency_to", - "rate" - ] - }, - "directory-data-exchange-rate-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface" - }, - "directory-data-currency-information-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface" - }, - "directory-data-country-information-interface": { - "type": "object", - "description": "Country Information interface.", - "properties": { - "id": { - "type": "string", - "description": "The country id for the store." - }, - "two_letter_abbreviation": { - "type": "string", - "description": "The country 2 letter abbreviation for the store." - }, - "three_letter_abbreviation": { - "type": "string", - "description": "The country 3 letter abbreviation for the store." - }, - "full_name_locale": { - "type": "string", - "description": "The country full name (in store locale) for the store." - }, - "full_name_english": { - "type": "string", - "description": "The country full name (in English) for the store." - }, - "available_regions": { - "type": "array", - "description": "The available regions for the store.", - "items": { - "$ref": "#/definitions/directory-data-region-information-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-country-information-extension-interface" - } - }, - "required": [ - "id", - "two_letter_abbreviation", - "three_letter_abbreviation", - "full_name_locale", - "full_name_english" - ] - }, - "directory-data-region-information-interface": { - "type": "object", - "description": "Region Information interface.", - "properties": { - "id": { - "type": "string", - "description": "Region id" - }, - "code": { - "type": "string", - "description": "Region code" - }, - "name": { - "type": "string", - "description": "Region name" - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-region-information-extension-interface" - } - }, - "required": [ - "id", - "code", - "name" - ] - }, - "directory-data-region-information-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface" - }, - "directory-data-country-information-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface" - }, - "eav-data-attribute-set-search-results-interface": { - "type": "object", - "description": "Interface AttributeSetSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Attribute sets list.", - "items": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "framework-search-criteria-interface": { - "type": "object", - "description": "Search criteria interface.", - "properties": { - "filter_groups": { - "type": "array", - "description": "A list of filter groups.", - "items": { - "$ref": "#/definitions/framework-search-filter-group" - } - }, - "sort_orders": { - "type": "array", - "description": "Sort order.", - "items": { - "$ref": "#/definitions/framework-sort-order" - } - }, - "page_size": { - "type": "integer", - "description": "Page size." - }, - "current_page": { - "type": "integer", - "description": "Current page." - } - }, - "required": [ - "filter_groups" - ] - }, - "framework-search-filter-group": { - "type": "object", - "description": "Groups two or more filters together using a logical OR", - "properties": { - "filters": { - "type": "array", - "description": "A list of filters in this group", - "items": { - "$ref": "#/definitions/framework-filter" - } - } - } - }, - "framework-filter": { - "type": "object", - "description": "Filter which can be used by any methods from service layer.", - "properties": { - "field": { - "type": "string", - "description": "Field" - }, - "value": { - "type": "string", - "description": "Value" - }, - "condition_type": { - "type": "string", - "description": "Condition type" - } - }, - "required": [ - "field", - "value" - ] - }, - "framework-sort-order": { - "type": "object", - "description": "Data object for sort order.", - "properties": { - "field": { - "type": "string", - "description": "Sorting field." - }, - "direction": { - "type": "string", - "description": "Sorting direction." - } - }, - "required": [ - "field", - "direction" - ] - }, - "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-group-search-results-interface": { - "type": "object", - "description": "Interface for customer groups search results.", - "properties": { - "items": { - "type": "array", - "description": "Customer groups list.", - "items": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "customer-data-attribute-metadata-interface": { - "type": "object", - "description": "Customer attribute metadata interface.", - "properties": { - "frontend_input": { - "type": "string", - "description": "HTML for input element." - }, - "input_filter": { - "type": "string", - "description": "Template used for input (e.g. \"date\")" - }, - "store_label": { - "type": "string", - "description": "Label of the store." - }, - "validation_rules": { - "type": "array", - "description": "Validation rules.", - "items": { - "$ref": "#/definitions/customer-data-validation-rule-interface" - } - }, - "multiline_count": { - "type": "integer", - "description": "Of lines of the attribute value." - }, - "visible": { - "type": "boolean", - "description": "Attribute is visible on frontend." - }, - "required": { - "type": "boolean", - "description": "Attribute is required." - }, - "data_model": { - "type": "string", - "description": "Data model for attribute." - }, - "options": { - "type": "array", - "description": "Options of the attribute (key => value pairs for select)", - "items": { - "$ref": "#/definitions/customer-data-option-interface" - } - }, - "frontend_class": { - "type": "string", - "description": "Class which is used to display the attribute on frontend." - }, - "user_defined": { - "type": "boolean", - "description": "Current attribute has been defined by a user." - }, - "sort_order": { - "type": "integer", - "description": "Attributes sort order." - }, - "frontend_label": { - "type": "string", - "description": "Label which supposed to be displayed on frontend." - }, - "note": { - "type": "string", - "description": "The note attribute for the element." - }, - "system": { - "type": "boolean", - "description": "This is a system attribute." - }, - "backend_type": { - "type": "string", - "description": "Backend type." - }, - "is_used_in_grid": { - "type": "boolean", - "description": "It is used in customer grid" - }, - "is_visible_in_grid": { - "type": "boolean", - "description": "It is visible in customer grid" - }, - "is_filterable_in_grid": { - "type": "boolean", - "description": "It is filterable in customer grid" - }, - "is_searchable_in_grid": { - "type": "boolean", - "description": "It is searchable in customer grid" - }, - "attribute_code": { - "type": "string", - "description": "Code of the attribute." - } - }, - "required": [ - "frontend_input", - "input_filter", - "store_label", - "validation_rules", - "multiline_count", - "visible", - "required", - "data_model", - "options", - "frontend_class", - "user_defined", - "sort_order", - "frontend_label", - "note", - "system", - "backend_type", - "attribute_code" - ] - }, - "customer-data-validation-rule-interface": { - "type": "object", - "description": "Validation rule interface.", - "properties": { - "name": { - "type": "string", - "description": "Validation rule name" - }, - "value": { - "type": "string", - "description": "Validation rule value" - } - }, - "required": [ - "name", - "value" - ] - }, - "customer-data-option-interface": { - "type": "object", - "description": "Option interface.", - "properties": { - "label": { - "type": "string", - "description": "Option label" - }, - "value": { - "type": "string", - "description": "Option value" - }, - "options": { - "type": "array", - "description": "Nested options", - "items": { - "$ref": "#/definitions/customer-data-option-interface" - } - } - }, - "required": [ - "label" - ] - }, - "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" - }, - "customer-data-customer-search-results-interface": { - "type": "object", - "description": "Interface for customer search results.", - "properties": { - "items": { - "type": "array", - "description": "Customers list.", - "items": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "customer-data-validation-results-interface": { - "type": "object", - "description": "Validation results interface.", - "properties": { - "valid": { - "type": "boolean", - "description": "If the provided data is valid." - }, - "messages": { - "type": "array", - "description": "Error messages as array in case of validation failure, else return empty array.", - "items": { - "type": "string" - } - } - }, - "required": [ - "valid", - "messages" - ] - }, - "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-page-search-results-interface": { - "type": "object", - "description": "Interface for cms page search results.", - "properties": { - "items": { - "type": "array", - "description": "Pages list.", - "items": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - ] - }, - "cms-data-block-search-results-interface": { - "type": "object", - "description": "Interface for cms block search results.", - "properties": { - "items": { - "type": "array", - "description": "Blocks list.", - "items": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "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" - }, - "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-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Attributes list.", - "items": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-product-attribute-type-interface": { - "type": "object", - "description": "", - "properties": { - "value": { - "type": "string", - "description": "Value" - }, - "label": { - "type": "string", - "description": "Type label" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-attribute-type-extension-interface" - } - }, - "required": [ - "value", - "label" - ] - }, - "catalog-data-product-attribute-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface" - }, - "catalog-data-product-attribute-interface": { - "type": "object", - "description": "", - "properties": { - "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" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-eav-attribute-extension-interface" - }, - "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" - ] - }, - "catalog-data-eav-attribute-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface" - }, - "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" - ] - }, - "catalog-data-product-attribute-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Attributes list.", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-category-attribute-interface": { - "type": "object", - "description": "", - "properties": { - "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" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-eav-attribute-extension-interface" - }, - "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" - ] - }, - "catalog-data-category-attribute-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Attributes list.", - "items": { - "$ref": "#/definitions/catalog-data-category-attribute-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-product-type-interface": { - "type": "object", - "description": "Product type details", - "properties": { - "name": { - "type": "string", - "description": "Product type code" - }, - "label": { - "type": "string", - "description": "Product type label" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-type-extension-interface" - } - }, - "required": [ - "name", - "label" - ] - }, - "catalog-data-product-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface" - }, - "eav-data-attribute-group-search-results-interface": { - "type": "object", - "description": "Interface AttributeGroupSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Attribute sets list.", - "items": { - "$ref": "#/definitions/eav-data-attribute-group-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-price-update-result-interface": { - "type": "object", - "description": "Interface returned in case of incorrect price passed to efficient price API.", - "properties": { - "message": { - "type": "string", - "description": "Error message, that contains description of error occurred during price update." - }, - "parameters": { - "type": "array", - "description": "Parameters, that could be displayed in error message placeholders.", - "items": { - "type": "string" - } - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-price-update-result-extension-interface" - } - }, - "required": [ - "message", - "parameters" - ] - }, - "catalog-data-price-update-result-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface" - }, - "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": "", - "properties": { - "id": { - "type": "integer" - }, - "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" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "path": { - "type": "string" - }, - "available_sort_by": { - "type": "array", - "items": { - "type": "string" - } - }, - "include_in_menu": { - "type": "boolean" - }, - "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-tree-interface": { - "type": "object", - "description": "", - "properties": { - "id": { - "type": "integer" - }, - "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" - }, - "product_count": { - "type": "integer", - "description": "Product count" - }, - "children_data": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-category-tree-interface" - } - } - }, - "required": [ - "parent_id", - "name", - "is_active", - "position", - "level", - "product_count", - "children_data" - ] - }, - "catalog-data-category-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Categories", - "items": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-product-custom-option-type-interface": { - "type": "object", - "description": "", - "properties": { - "label": { - "type": "string", - "description": "Option type label" - }, - "code": { - "type": "string", - "description": "Option type code" - }, - "group": { - "type": "string", - "description": "Option type group" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-custom-option-type-extension-interface" - } - }, - "required": [ - "label", - "code", - "group" - ] - }, - "catalog-data-product-custom-option-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface" - }, - "catalog-data-product-link-type-interface": { - "type": "object", - "description": "", - "properties": { - "code": { - "type": "integer", - "description": "Link type code" - }, - "name": { - "type": "string", - "description": "Link type name" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-link-type-extension-interface" - } - }, - "required": [ - "code", - "name" - ] - }, - "catalog-data-product-link-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface" - }, - "catalog-data-product-link-attribute-interface": { - "type": "object", - "description": "", - "properties": { - "code": { - "type": "string", - "description": "Attribute code" - }, - "type": { - "type": "string", - "description": "Attribute type" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-link-attribute-extension-interface" - } - }, - "required": [ - "code", - "type" - ] - }, - "catalog-data-product-link-attribute-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface" - }, - "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" - ] - }, - "catalog-data-product-render-search-results-interface": { - "type": "object", - "description": "Dto that holds render information about products", - "properties": { - "items": { - "type": "array", - "description": "List of products rendered information", - "items": { - "$ref": "#/definitions/catalog-data-product-render-interface" - } - } - }, - "required": [ - "items" - ] - }, - "catalog-data-product-render-interface": { - "type": "object", - "description": "Represents Data Object which holds enough information to render product This information is put into part as Add To Cart or Add to Compare Data or Price Data", - "properties": { - "add_to_cart_button": { - "$ref": "#/definitions/catalog-data-product-render-button-interface" - }, - "add_to_compare_button": { - "$ref": "#/definitions/catalog-data-product-render-button-interface" - }, - "price_info": { - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - }, - "images": { - "type": "array", - "description": "Enough information, that needed to render image on front", - "items": { - "$ref": "#/definitions/catalog-data-product-render-image-interface" - } - }, - "url": { - "type": "string", - "description": "Product url" - }, - "id": { - "type": "integer", - "description": "Product identifier" - }, - "name": { - "type": "string", - "description": "Product name" - }, - "type": { - "type": "string", - "description": "Product type. Such as bundle, grouped, simple, etc..." - }, - "is_salable": { - "type": "string", - "description": "Information about product saleability (In Stock)" - }, - "store_id": { - "type": "integer", - "description": "Information about current store id or requested store id" - }, - "currency_code": { - "type": "string", - "description": "Current or desired currency code to product" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-extension-interface" - } - }, - "required": [ - "add_to_cart_button", - "add_to_compare_button", - "price_info", - "images", - "url", - "id", - "name", - "type", - "is_salable", - "store_id", - "currency_code", - "extension_attributes" - ] - }, - "catalog-data-product-render-button-interface": { - "type": "object", - "description": "Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend", - "properties": { - "post_data": { - "type": "string", - "description": "Post data" - }, - "url": { - "type": "string", - "description": "Url, needed to add product to cart" - }, - "required_options": { - "type": "boolean", - "description": "Flag whether a product has options or not" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-button-extension-interface" - } - }, - "required": [ - "post_data", - "url", - "required_options" - ] - }, - "catalog-data-product-render-button-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ButtonInterface" - }, - "catalog-data-product-render-price-info-interface": { - "type": "object", - "description": "Price interface.", - "properties": { - "final_price": { - "type": "number", - "description": "Final price" - }, - "max_price": { - "type": "number", - "description": "Max price of a product" - }, - "max_regular_price": { - "type": "number", - "description": "Max regular price" - }, - "minimal_regular_price": { - "type": "number", - "description": "Minimal regular price" - }, - "special_price": { - "type": "number", - "description": "Special price" - }, - "minimal_price": { - "type": "number" - }, - "regular_price": { - "type": "number", - "description": "Regular price" - }, - "formatted_prices": { - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface" - } - }, - "required": [ - "final_price", - "max_price", - "max_regular_price", - "minimal_regular_price", - "special_price", - "minimal_price", - "regular_price", - "formatted_prices" - ] - }, - "catalog-data-product-render-formatted-price-info-interface": { - "type": "object", - "description": "Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html", - "properties": { - "final_price": { - "type": "string", - "description": "Html with final price" - }, - "max_price": { - "type": "string", - "description": "Max price of a product" - }, - "minimal_price": { - "type": "string", - "description": "The minimal price of the product or variation" - }, - "max_regular_price": { - "type": "string", - "description": "Max regular price" - }, - "minimal_regular_price": { - "type": "string", - "description": "Minimal regular price" - }, - "special_price": { - "type": "string", - "description": "Special price" - }, - "regular_price": { - "type": "string", - "description": "Price - is price of product without discounts and special price with taxes and fixed product tax" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface" - } - }, - "required": [ - "final_price", - "max_price", - "minimal_price", - "max_regular_price", - "minimal_regular_price", - "special_price", - "regular_price" - ] - }, - "catalog-data-product-render-formatted-price-info-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\FormattedPriceInfoInterface" - }, - "catalog-data-product-render-price-info-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\PriceInfoInterface", - "properties": { - "msrp": { - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface" - }, - "tax_adjustments": { - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - }, - "weee_attributes": { - "type": "array", - "items": { - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface" - } - }, - "weee_adjustment": { - "type": "string" - } - } - }, - "msrp-data-product-render-msrp-price-info-interface": { - "type": "object", - "description": "Price interface.", - "properties": { - "msrp_price": { - "type": "string" - }, - "is_applicable": { - "type": "string" - }, - "is_shown_price_on_gesture": { - "type": "string" - }, - "msrp_message": { - "type": "string" - }, - "explanation_message": { - "type": "string" - }, - "extension_attributes": { - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface" - } - }, - "required": [ - "msrp_price", - "is_applicable", - "is_shown_price_on_gesture", - "msrp_message", - "explanation_message" - ] - }, - "msrp-data-product-render-msrp-price-info-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Msrp\\Api\\Data\\ProductRender\\MsrpPriceInfoInterface" - }, - "weee-data-product-render-weee-adjustment-attribute-interface": { - "type": "object", - "description": "List of all weee attributes, their amounts, etc.., that product has", - "properties": { - "amount": { - "type": "string", - "description": "Weee attribute amount" - }, - "tax_amount": { - "type": "string", - "description": "Tax which is calculated to fixed product tax attribute" - }, - "tax_amount_incl_tax": { - "type": "string", - "description": "Tax amount of weee attribute" - }, - "amount_excl_tax": { - "type": "string", - "description": "Product amount exclude tax" - }, - "attribute_code": { - "type": "string", - "description": "Weee attribute code" - }, - "extension_attributes": { - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface" - } - }, - "required": [ - "amount", - "tax_amount", - "tax_amount_incl_tax", - "amount_excl_tax", - "attribute_code", - "extension_attributes" - ] - }, - "weee-data-product-render-weee-adjustment-attribute-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Weee\\Api\\Data\\ProductRender\\WeeeAdjustmentAttributeInterface" - }, - "catalog-data-product-render-image-interface": { - "type": "object", - "description": "Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view", - "properties": { - "url": { - "type": "string", - "description": "Image url" - }, - "code": { - "type": "string", - "description": "Image code" - }, - "height": { - "type": "number", - "description": "Image height" - }, - "width": { - "type": "number", - "description": "Image width in px" - }, - "label": { - "type": "string", - "description": "Image label" - }, - "resized_width": { - "type": "number", - "description": "Resize width" - }, - "resized_height": { - "type": "number", - "description": "Resize height" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-image-extension-interface" - } - }, - "required": [ - "url", - "code", - "height", - "width", - "label", - "resized_width", - "resized_height" - ] - }, - "catalog-data-product-render-image-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ImageInterface" - }, - "catalog-data-product-render-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRenderInterface", - "properties": { - "wishlist_button": { - "$ref": "#/definitions/catalog-data-product-render-button-interface" - }, - "review_html": { - "type": "string" - } - } - }, - "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" - }, - "quote-data-cart-item-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface", - "properties": { - "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-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": { - "gift_registry_id": { - "type": "integer" - }, - "checkout_fields": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - } - }, - "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": { - "type": "string" - } - } - }, - "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" - }, - "quote-data-cart-search-results-interface": { - "type": "object", - "description": "Interface CartSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Carts list.", - "items": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-shipping-method-interface": { - "type": "object", - "description": "Interface ShippingMethodInterface", - "properties": { - "carrier_code": { - "type": "string", - "description": "Shipping carrier code." - }, - "method_code": { - "type": "string", - "description": "Shipping method code." - }, - "carrier_title": { - "type": "string", - "description": "Shipping carrier title. Otherwise, null." - }, - "method_title": { - "type": "string", - "description": "Shipping method title. Otherwise, null." - }, - "amount": { - "type": "number", - "description": "Shipping amount in store currency." - }, - "base_amount": { - "type": "number", - "description": "Shipping amount in base currency." - }, - "available": { - "type": "boolean", - "description": "The value of the availability flag for the current shipping method." - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-shipping-method-extension-interface" - }, - "error_message": { - "type": "string", - "description": "Shipping Error message." - }, - "price_excl_tax": { - "type": "number", - "description": "Shipping price excl tax." - }, - "price_incl_tax": { - "type": "number", - "description": "Shipping price incl tax." - } - }, - "required": [ - "carrier_code", - "method_code", - "amount", - "base_amount", - "available", - "error_message", - "price_excl_tax", - "price_incl_tax" - ] - }, - "quote-data-shipping-method-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface" - }, - "quote-data-payment-method-interface": { - "type": "object", - "description": "Interface PaymentMethodInterface", - "properties": { - "code": { - "type": "string", - "description": "Payment method code" - }, - "title": { - "type": "string", - "description": "Payment method title" - } - }, - "required": [ - "code", - "title" - ] - }, - "quote-data-totals-interface": { - "type": "object", - "description": "Interface TotalsInterface", - "properties": { - "grand_total": { - "type": "number", - "description": "Grand total in quote currency" - }, - "base_grand_total": { - "type": "number", - "description": "Grand total in base currency" - }, - "subtotal": { - "type": "number", - "description": "Subtotal in quote currency" - }, - "base_subtotal": { - "type": "number", - "description": "Subtotal in base currency" - }, - "discount_amount": { - "type": "number", - "description": "Discount amount in quote currency" - }, - "base_discount_amount": { - "type": "number", - "description": "Discount amount in base currency" - }, - "subtotal_with_discount": { - "type": "number", - "description": "Subtotal in quote currency with applied discount" - }, - "base_subtotal_with_discount": { - "type": "number", - "description": "Subtotal in base currency with applied discount" - }, - "shipping_amount": { - "type": "number", - "description": "Shipping amount in quote currency" - }, - "base_shipping_amount": { - "type": "number", - "description": "Shipping amount in base currency" - }, - "shipping_discount_amount": { - "type": "number", - "description": "Shipping discount amount in quote currency" - }, - "base_shipping_discount_amount": { - "type": "number", - "description": "Shipping discount amount in base currency" - }, - "tax_amount": { - "type": "number", - "description": "Tax amount in quote currency" - }, - "base_tax_amount": { - "type": "number", - "description": "Tax amount in base currency" - }, - "weee_tax_applied_amount": { - "type": "number", - "description": "Item weee tax applied amount in quote currency." - }, - "shipping_tax_amount": { - "type": "number", - "description": "Shipping tax amount in quote currency" - }, - "base_shipping_tax_amount": { - "type": "number", - "description": "Shipping tax amount in base currency" - }, - "subtotal_incl_tax": { - "type": "number", - "description": "Subtotal including tax in quote currency" - }, - "base_subtotal_incl_tax": { - "type": "number", - "description": "Subtotal including tax in base currency" - }, - "shipping_incl_tax": { - "type": "number", - "description": "Shipping including tax in quote currency" - }, - "base_shipping_incl_tax": { - "type": "number", - "description": "Shipping including tax in base currency" - }, - "base_currency_code": { - "type": "string", - "description": "Base currency code" - }, - "quote_currency_code": { - "type": "string", - "description": "Quote currency code" - }, - "coupon_code": { - "type": "string", - "description": "Applied coupon code" - }, - "items_qty": { - "type": "integer", - "description": "Items qty" - }, - "items": { - "type": "array", - "description": "Totals by items", - "items": { - "$ref": "#/definitions/quote-data-totals-item-interface" - } - }, - "total_segments": { - "type": "array", - "description": "Dynamically calculated totals", - "items": { - "$ref": "#/definitions/quote-data-total-segment-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-totals-extension-interface" - } - }, - "required": [ - "weee_tax_applied_amount", - "total_segments" - ] - }, - "quote-data-totals-item-interface": { - "type": "object", - "description": "Interface TotalsItemInterface", - "properties": { - "item_id": { - "type": "integer", - "description": "Item id" - }, - "price": { - "type": "number", - "description": "Item price in quote currency." - }, - "base_price": { - "type": "number", - "description": "Item price in base currency." - }, - "qty": { - "type": "number", - "description": "Item quantity." - }, - "row_total": { - "type": "number", - "description": "Row total in quote currency." - }, - "base_row_total": { - "type": "number", - "description": "Row total in base currency." - }, - "row_total_with_discount": { - "type": "number", - "description": "Row total with discount in quote currency. Otherwise, null." - }, - "tax_amount": { - "type": "number", - "description": "Tax amount in quote currency. Otherwise, null." - }, - "base_tax_amount": { - "type": "number", - "description": "Tax amount in base currency. Otherwise, null." - }, - "tax_percent": { - "type": "number", - "description": "Tax percent. Otherwise, null." - }, - "discount_amount": { - "type": "number", - "description": "Discount amount in quote currency. Otherwise, null." - }, - "base_discount_amount": { - "type": "number", - "description": "Discount amount in base currency. Otherwise, null." - }, - "discount_percent": { - "type": "number", - "description": "Discount percent. Otherwise, null." - }, - "price_incl_tax": { - "type": "number", - "description": "Price including tax in quote currency. Otherwise, null." - }, - "base_price_incl_tax": { - "type": "number", - "description": "Price including tax in base currency. Otherwise, null." - }, - "row_total_incl_tax": { - "type": "number", - "description": "Row total including tax in quote currency. Otherwise, null." - }, - "base_row_total_incl_tax": { - "type": "number", - "description": "Row total including tax in base currency. Otherwise, null." - }, - "options": { - "type": "string", - "description": "Item price in quote currency." - }, - "weee_tax_applied_amount": { - "type": "number", - "description": "Item weee tax applied amount in quote currency." - }, - "weee_tax_applied": { - "type": "string", - "description": "Item weee tax applied in quote currency." - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-totals-item-extension-interface" - }, - "name": { - "type": "string", - "description": "Product name. Otherwise, null." - } - }, - "required": [ - "item_id", - "price", - "base_price", - "qty", - "row_total", - "base_row_total", - "options", - "weee_tax_applied_amount", - "weee_tax_applied" - ] - }, - "quote-data-totals-item-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface", - "properties": { - "negotiable_quote_item_totals": { - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface" - } - } - }, - "negotiable-quote-data-negotiable-quote-item-totals-interface": { - "type": "object", - "description": "Extension attribute for quote item totals model.", - "properties": { - "cost": { - "type": "number", - "description": "Cost for quote item." - }, - "catalog_price": { - "type": "number", - "description": "Catalog price for quote item." - }, - "base_catalog_price": { - "type": "number", - "description": "Catalog price for quote item in base currency." - }, - "catalog_price_incl_tax": { - "type": "number", - "description": "Catalog price with included tax for quote item." - }, - "base_catalog_price_incl_tax": { - "type": "number", - "description": "Catalog price with included tax for quote item in base currency." - }, - "cart_price": { - "type": "number", - "description": "Cart price for quote item." - }, - "base_cart_price": { - "type": "number", - "description": "Cart price for quote item in base currency." - }, - "cart_tax": { - "type": "number", - "description": "Tax from catalog price for quote item." - }, - "base_cart_tax": { - "type": "number", - "description": "Tax from catalog price for quote item in base currency." - }, - "cart_price_incl_tax": { - "type": "number", - "description": "Cart price with included tax for quote item." - }, - "base_cart_price_incl_tax": { - "type": "number", - "description": "Cart price with included tax for quote item in base currency." - }, - "extension_attributes": { - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface" - } - }, - "required": [ - "cost", - "catalog_price", - "base_catalog_price", - "catalog_price_incl_tax", - "base_catalog_price_incl_tax", - "cart_price", - "base_cart_price", - "cart_tax", - "base_cart_tax", - "cart_price_incl_tax", - "base_cart_price_incl_tax" - ] - }, - "negotiable-quote-data-negotiable-quote-item-totals-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteItemTotalsInterface" - }, - "quote-data-total-segment-interface": { - "type": "object", - "description": "Interface TotalsInterface", - "properties": { - "code": { - "type": "string", - "description": "Code" - }, - "title": { - "type": "string", - "description": "Total title" - }, - "value": { - "type": "number", - "description": "Total value" - }, - "area": { - "type": "string", - "description": "Display area code." - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-total-segment-extension-interface" - } - }, - "required": [ - "code", - "value" - ] - }, - "quote-data-total-segment-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface", - "properties": { - "tax_grandtotal_details": { - "type": "array", - "items": { - "$ref": "#/definitions/tax-data-grand-total-details-interface" - } - }, - "gift_cards": { - "type": "string" - }, - "gw_order_id": { - "type": "string" - }, - "gw_item_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "gw_allow_gift_receipt": { - "type": "string" - }, - "gw_add_card": { - "type": "string" - }, - "gw_price": { - "type": "string" - }, - "gw_base_price": { - "type": "string" - }, - "gw_items_price": { - "type": "string" - }, - "gw_items_base_price": { - "type": "string" - }, - "gw_card_price": { - "type": "string" - }, - "gw_card_base_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_price_incl_tax": { - "type": "string" - }, - "gw_base_price_incl_tax": { - "type": "string" - }, - "gw_card_price_incl_tax": { - "type": "string" - }, - "gw_card_base_price_incl_tax": { - "type": "string" - }, - "gw_items_price_incl_tax": { - "type": "string" - }, - "gw_items_base_price_incl_tax": { - "type": "string" - } - } - }, - "tax-data-grand-total-details-interface": { - "type": "object", - "description": "Interface GrandTotalDetailsInterface", - "properties": { - "amount": { - "type": "number", - "description": "Tax amount value" - }, - "rates": { - "type": "array", - "description": "Tax rates info", - "items": { - "$ref": "#/definitions/tax-data-grand-total-rates-interface" - } - }, - "group_id": { - "type": "integer", - "description": "Group identifier" - } - }, - "required": [ - "amount", - "rates", - "group_id" - ] - }, - "tax-data-grand-total-rates-interface": { - "type": "object", - "description": "Interface GrandTotalRatesInterface", - "properties": { - "percent": { - "type": "string", - "description": "Tax percentage value" - }, - "title": { - "type": "string", - "description": "Rate title" - } - }, - "required": [ - "percent", - "title" - ] - }, - "quote-data-totals-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface", - "properties": { - "coupon_label": { - "type": "string" - }, - "base_customer_balance_amount": { - "type": "number" - }, - "customer_balance_amount": { - "type": "number" - }, - "negotiable_quote_totals": { - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface" - }, - "reward_points_balance": { - "type": "number" - }, - "reward_currency_amount": { - "type": "number" - }, - "base_reward_currency_amount": { - "type": "number" - } - } - }, - "negotiable-quote-data-negotiable-quote-totals-interface": { - "type": "object", - "description": "Extension attribute for quote totals model.", - "properties": { - "items_count": { - "type": "integer", - "description": "The number of different items or products in the cart." - }, - "quote_status": { - "type": "string", - "description": "Negotiable quote status." - }, - "created_at": { - "type": "string", - "description": "The cart creation date and time." - }, - "updated_at": { - "type": "string", - "description": "The cart last update date and time." - }, - "customer_group": { - "type": "integer", - "description": "Customer group id." - }, - "base_to_quote_rate": { - "type": "number", - "description": "Base currency to quote currency rate." - }, - "cost_total": { - "type": "number", - "description": "Total cost for quote." - }, - "base_cost_total": { - "type": "number", - "description": "Total cost for quote in base currency." - }, - "original_total": { - "type": "number", - "description": "Original quote total." - }, - "base_original_total": { - "type": "number", - "description": "Original quote total in base currency." - }, - "original_tax": { - "type": "number", - "description": "Original tax amount for quote." - }, - "base_original_tax": { - "type": "number", - "description": "Original tax amount for quote in base currency." - }, - "original_price_incl_tax": { - "type": "number", - "description": "Original price with included tax for quote." - }, - "base_original_price_incl_tax": { - "type": "number", - "description": "Original price with included tax for quote in base currency." - }, - "negotiated_price_type": { - "type": "integer", - "description": "Negotiable quote type." - }, - "negotiated_price_value": { - "type": "number", - "description": "Negotiable price value for quote." - } - }, - "required": [ - "items_count", - "quote_status", - "created_at", - "updated_at", - "customer_group", - "base_to_quote_rate", - "cost_total", - "base_cost_total", - "original_total", - "base_original_total", - "original_tax", - "base_original_tax", - "original_price_incl_tax", - "base_original_price_incl_tax", - "negotiated_price_type", - "negotiated_price_value" - ] - }, - "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" - } - } - }, - "catalog-inventory-data-stock-item-collection-interface": { - "type": "object", - "description": "Interface StockItemCollectionInterface", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/catalog-inventory-stock-item-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-inventory-stock-item-criteria-interface": { - "type": "object", - "description": "Interface StockItemCriteriaInterface", - "properties": { - "mapper_interface_name": { - "type": "string", - "description": "Associated Mapper Interface name" - }, - "criteria_list": { - "type": "array", - "description": "Criteria objects added to current Composite Criteria", - "items": { - "$ref": "#/definitions/framework-criteria-interface" - } - }, - "filters": { - "type": "array", - "description": "List of filters", - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Ordering criteria", - "items": { - "type": "string" - } - }, - "limit": { - "type": "array", - "description": "Limit", - "items": { - "type": "string" - } - } - }, - "required": [ - "mapper_interface_name", - "criteria_list", - "filters", - "orders", - "limit" - ] - }, - "framework-criteria-interface": { - "type": "object", - "description": "Interface CriteriaInterface", - "properties": { - "mapper_interface_name": { - "type": "string", - "description": "Associated Mapper Interface name" - }, - "criteria_list": { - "type": "array", - "description": "Criteria objects added to current Composite Criteria", - "items": { - "$ref": "#/definitions/framework-criteria-interface" - } - }, - "filters": { - "type": "array", - "description": "List of filters", - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Ordering criteria", - "items": { - "type": "string" - } - }, - "limit": { - "type": "array", - "description": "Limit", - "items": { - "type": "string" - } - } - }, - "required": [ - "mapper_interface_name", - "criteria_list", - "filters", - "orders", - "limit" - ] - }, - "catalog-inventory-data-stock-status-interface": { - "type": "object", - "description": "Interface StockStatusInterface", - "properties": { - "product_id": { - "type": "integer" - }, - "stock_id": { - "type": "integer" - }, - "qty": { - "type": "integer" - }, - "stock_status": { - "type": "integer" - }, - "stock_item": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-inventory-data-stock-status-extension-interface" - } - }, - "required": [ - "product_id", - "stock_id", - "qty", - "stock_status", - "stock_item" - ] - }, - "catalog-inventory-data-stock-status-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface" - }, - "bundle-data-option-type-interface": { - "type": "object", - "description": "Interface OptionTypeInterface", - "properties": { - "label": { - "type": "string", - "description": "Type label" - }, - "code": { - "type": "string", - "description": "Type code" - }, - "extension_attributes": { - "$ref": "#/definitions/bundle-data-option-type-extension-interface" - } - }, - "required": [ - "label", - "code" - ] - }, - "bundle-data-option-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface" - }, - "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": "string", - "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" - }, - "framework-search-search-result-interface": { - "type": "object", - "description": "Interface SearchResultInterface", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-search-document-interface" - } - }, - "aggregations": { - "$ref": "#/definitions/framework-search-aggregation-interface" - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "aggregations", - "search_criteria", - "total_count" - ] - }, - "framework-search-document-interface": { - "type": "object", - "description": "Interface \\Magento\\Framework\\Api\\Search\\DocumentInterface", - "properties": { - "id": { - "type": "integer" - }, - "custom_attributes": { - "type": "array", - "description": "Custom attributes values.", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - }, - "required": [ - "id" - ] - }, - "framework-search-aggregation-interface": { - "type": "object", - "description": "Faceted data", - "properties": { - "buckets": { - "type": "array", - "description": "All Document fields", - "items": { - "$ref": "#/definitions/framework-search-bucket-interface" - } - }, - "bucket_names": { - "type": "array", - "description": "Document field names", - "items": { - "type": "string" - } - } - }, - "required": [ - "buckets", - "bucket_names" - ] - }, - "framework-search-bucket-interface": { - "type": "object", - "description": "Facet Bucket", - "properties": { - "name": { - "type": "string", - "description": "Field name" - }, - "values": { - "type": "array", - "description": "Field values", - "items": { - "$ref": "#/definitions/framework-search-aggregation-value-interface" - } - } - }, - "required": [ - "name", - "values" - ] - }, - "framework-search-aggregation-value-interface": { - "type": "object", - "description": "Interface \\Magento\\Framework\\Api\\Search\\AggregationValueInterface", - "properties": { - "value": { - "type": "string", - "description": "Aggregation" - }, - "metrics": { - "type": "array", - "description": "Metrics", - "items": { - "type": "string" - } - } - }, - "required": [ - "value", - "metrics" - ] - }, - "framework-search-search-criteria-interface": { - "type": "object", - "description": "Interface SearchCriteriaInterface", - "properties": { - "request_name": { - "type": "string" - }, - "filter_groups": { - "type": "array", - "description": "A list of filter groups.", - "items": { - "$ref": "#/definitions/framework-search-filter-group" - } - }, - "sort_orders": { - "type": "array", - "description": "Sort order.", - "items": { - "$ref": "#/definitions/framework-sort-order" - } - }, - "page_size": { - "type": "integer", - "description": "Page size." - }, - "current_page": { - "type": "integer", - "description": "Current page." - } - }, - "required": [ - "request_name", - "filter_groups" - ] - }, - "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" - } - } - }, - "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", - "properties": { - "checkout_fields": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - } - }, - "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": { - "type": "string" - } - } - }, - "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", - "properties": { - "ext_order_id": { - "type": "string" - }, - "shipping_experience": { - "$ref": "#/definitions/temando-shipping-data-order-shipping-experience-interface" - }, - "collection_point": { - "$ref": "#/definitions/temando-shipping-data-collection-point-order-collection-point-interface" - } - } - }, - "temando-shipping-data-order-shipping-experience-interface": { - "type": "object", - "description": "Temando Shipping Experience Interface Local representation of a shipping rate in checkout. A set of shipping experiences is the result of creating an order at the Temando platform. (!) Needs to reside in Api namespace because selected shipping experience is exposed to public as a ShippingInterface extension attribute.", - "properties": { - "label": { - "type": "string" - }, - "code": { - "type": "string" - }, - "cost": { - "type": "number" - } - }, - "required": [ - "label", - "code", - "cost" - ] - }, - "temando-shipping-data-collection-point-order-collection-point-interface": { - "type": "object", - "description": "Temando Order Collection Point Interface – Order Details/Fulfillment", - "properties": { - "recipient_address_id": { - "type": "integer" - }, - "collection_point_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "country": { - "type": "string" - }, - "region": { - "type": "string" - }, - "postcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "street": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "recipient_address_id", - "collection_point_id", - "name", - "country", - "region", - "postcode", - "city", - "street" - ] - }, - "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" - ] - }, - "sales-data-order-search-result-interface": { - "type": "object", - "description": "Order search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-order-status-history-search-result-interface": { - "type": "object", - "description": "Order status history search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-order-status-history-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-order-item-search-result-interface": { - "type": "object", - "description": "Order item search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-order-item-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "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" - } - } - }, - "sales-data-invoice-search-result-interface": { - "type": "object", - "description": "Invoice search result interface. An invoice is a record of the receipt of payment for an order.", - "properties": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-invoice-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-invoice-comment-search-result-interface": { - "type": "object", - "description": "Invoice comment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-invoice-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-comment-search-result-interface": { - "type": "object", - "description": "Credit memo comment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-creditmemo-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-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" - }, - "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-creditmemo-search-result-interface": { - "type": "object", - "description": "Credit memo search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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": { - "ext_shipment_id": { - "type": "string" - }, - "ext_return_shipment_id": { - "type": "string" - }, - "ext_location_id": { - "type": "string" - }, - "ext_tracking_url": { - "type": "string" - }, - "ext_tracking_reference": { - "type": "string" - } - } - }, - "sales-data-shipment-search-result-interface": { - "type": "object", - "description": "Shipment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-shipment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-shipment-comment-search-result-interface": { - "type": "object", - "description": "Shipment comment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-shipment-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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": { - "shipping_label": { - "type": "string" - }, - "ext_shipment_id": { - "type": "string" - }, - "ext_return_shipment_id": { - "type": "string" - }, - "ext_location_id": { - "type": "string" - }, - "ext_tracking_url": { - "type": "string" - }, - "ext_tracking_reference": { - "type": "string" - } - } - }, - "sales-data-transaction-interface": { - "type": "object", - "description": "Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.", - "properties": { - "transaction_id": { - "type": "integer", - "description": "Transaction ID." - }, - "parent_id": { - "type": "integer", - "description": "The parent ID for the transaction. Otherwise, null." - }, - "order_id": { - "type": "integer", - "description": "Order ID." - }, - "payment_id": { - "type": "integer", - "description": "Payment ID." - }, - "txn_id": { - "type": "string", - "description": "Transaction business ID." - }, - "parent_txn_id": { - "type": "string", - "description": "Parent transaction business ID." - }, - "txn_type": { - "type": "string", - "description": "Transaction type." - }, - "is_closed": { - "type": "integer", - "description": "Is-closed flag value." - }, - "additional_information": { - "type": "array", - "description": "Array of additional information. Otherwise, null.", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "description": "Created-at timestamp." - }, - "child_transactions": { - "type": "array", - "description": "Array of child transactions.", - "items": { - "$ref": "#/definitions/sales-data-transaction-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/sales-data-transaction-extension-interface" - } - }, - "required": [ - "transaction_id", - "order_id", - "payment_id", - "txn_id", - "parent_txn_id", - "txn_type", - "is_closed", - "created_at", - "child_transactions" - ] - }, - "sales-data-transaction-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface" - }, - "sales-data-transaction-search-result-interface": { - "type": "object", - "description": "Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.", - "properties": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-transaction-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "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-payment-details-interface": { - "type": "object", - "description": "Interface PaymentDetailsInterface", - "properties": { - "payment_methods": { - "type": "array", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - }, - "totals": { - "$ref": "#/definitions/quote-data-totals-interface" - }, - "extension_attributes": { - "$ref": "#/definitions/checkout-data-payment-details-extension-interface" - } - }, - "required": [ - "payment_methods", - "totals" - ] - }, - "checkout-data-payment-details-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface" - }, - "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-rule-search-result-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Rules.", - "items": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "sales-rule-data-coupon-search-result-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Rules.", - "items": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "sales-rule-data-coupon-mass-delete-result-interface": { - "type": "object", - "description": "Coupon mass delete results interface.", - "properties": { - "failed_items": { - "type": "array", - "description": "List of failed items.", - "items": { - "type": "string" - } - }, - "missing_items": { - "type": "array", - "description": "List of missing items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "failed_items", - "missing_items" - ] - }, - "checkout-agreements-data-agreement-interface": { - "type": "object", - "description": "Interface AgreementInterface", - "properties": { - "agreement_id": { - "type": "integer", - "description": "Agreement ID." - }, - "name": { - "type": "string", - "description": "Agreement name." - }, - "content": { - "type": "string", - "description": "Agreement content." - }, - "content_height": { - "type": "string", - "description": "Agreement content height. Otherwise, null." - }, - "checkbox_text": { - "type": "string", - "description": "Agreement checkbox text." - }, - "is_active": { - "type": "boolean", - "description": "Agreement status." - }, - "is_html": { - "type": "boolean", - "description": "* true - HTML. * false - plain text." - }, - "mode": { - "type": "integer", - "description": "The agreement applied mode." - }, - "extension_attributes": { - "$ref": "#/definitions/checkout-agreements-data-agreement-extension-interface" - } - }, - "required": [ - "agreement_id", - "name", - "content", - "checkbox_text", - "is_active", - "is_html", - "mode" - ] - }, - "checkout-agreements-data-agreement-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface" - }, - "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-rate-search-results-interface": { - "type": "object", - "description": "Interface for tax rate search results.", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-rule-search-results-interface": { - "type": "object", - "description": "Interface for tax rule search results.", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "tax-data-tax-class-search-results-interface": { - "type": "object", - "description": "Interface for tax class search results.", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/tax-data-tax-class-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "company-data-company-search-results-interface": { - "type": "object", - "description": "Interface for company search results", - "properties": { - "items": { - "type": "array", - "description": "Companies list", - "items": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-search-results-interface": { - "type": "object", - "description": "Interface for company team search results", - "properties": { - "items": { - "type": "array", - "description": "Teams list", - "items": { - "$ref": "#/definitions/company-data-team-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-hierarchy-interface": { - "type": "object", - "description": "Company hierarchy DTO interface for WebAPI.", - "properties": { - "structure_id": { - "type": "integer", - "description": "Structure ID." - }, - "entity_id": { - "type": "integer", - "description": "Entity ID." - }, - "entity_type": { - "type": "string", - "description": "Entity type." - }, - "structure_parent_id": { - "type": "integer", - "description": "Structure parent ID." - }, - "extension_attributes": { - "$ref": "#/definitions/company-data-hierarchy-extension-interface" - } - } - }, - "company-data-hierarchy-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\HierarchyInterface" - }, - "company-data-role-search-results-interface": { - "type": "object", - "description": "Interface for role search results.", - "properties": { - "items": { - "type": "array", - "description": "Roles list.", - "items": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "analytics-data-link-interface": { - "type": "object", - "description": "Interface LinkInterface Represents link with collected data and initialized vector for decryption.", - "properties": { - "url": { - "type": "string" - }, - "initialization_vector": { - "type": "string" - } - }, - "required": [ - "url", - "initialization_vector" - ] - }, - "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" - }, - "negotiable-quote-data-comment-interface": { - "type": "object", - "description": "Interface CommentInterface", - "properties": { - "entity_id": { - "type": "integer", - "description": "Comment ID." - }, - "parent_id": { - "type": "integer", - "description": "Negotiable quote ID, that this comment belongs to." - }, - "creator_type": { - "type": "integer", - "description": "The comment creator type." - }, - "is_decline": { - "type": "integer", - "description": "Is quote was declined by seller." - }, - "is_draft": { - "type": "integer", - "description": "Is quote draft flag." - }, - "creator_id": { - "type": "integer", - "description": "Comment creator ID." - }, - "comment": { - "type": "string", - "description": "Comment." - }, - "created_at": { - "type": "string", - "description": "Comment created at." - }, - "extension_attributes": { - "$ref": "#/definitions/negotiable-quote-data-comment-extension-interface" - }, - "attachments": { - "type": "array", - "description": "Existing attachments.", - "items": { - "$ref": "#/definitions/negotiable-quote-data-comment-attachment-interface" - } - } - }, - "required": [ - "entity_id", - "parent_id", - "creator_type", - "is_decline", - "is_draft", - "creator_id", - "comment", - "created_at", - "attachments" - ] - }, - "negotiable-quote-data-comment-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentInterface" - }, - "negotiable-quote-data-comment-attachment-interface": { - "type": "object", - "description": "Interface for quote comment attachment.", - "properties": { - "attachment_id": { - "type": "integer", - "description": "Attachment ID." - }, - "comment_id": { - "type": "integer", - "description": "Comment ID." - }, - "file_name": { - "type": "string", - "description": "File name." - }, - "file_path": { - "type": "string", - "description": "File path." - }, - "file_type": { - "type": "string", - "description": "File type." - }, - "extension_attributes": { - "$ref": "#/definitions/negotiable-quote-data-comment-attachment-extension-interface" - } - }, - "required": [ - "attachment_id", - "comment_id", - "file_name", - "file_path", - "file_type" - ] - }, - "negotiable-quote-data-comment-attachment-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentAttachmentInterface" - }, - "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", - "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" - }, - "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 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" - ] - }, - "shared-catalog-data-search-results-interface": { - "type": "object", - "description": "Interface for Shared Catalog search results.", - "properties": { - "items": { - "type": "array", - "description": "Shared Catalog list.", - "items": { - "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "gift-wrapping-data-wrapping-search-results-interface": { - "type": "object", - "description": "Interface WrappingSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-track-search-result-interface": { - "type": "object", - "description": "Interface TrackSearchResultInterface", - "properties": { - "items": { - "type": "array", - "description": "Rma list", - "items": { - "$ref": "#/definitions/rma-data-track-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "rma-data-comment-search-result-interface": { - "type": "object", - "description": "Interface CommentSearchResultInterface", - "properties": { - "items": { - "type": "array", - "description": "Rma Status History list", - "items": { - "$ref": "#/definitions/rma-data-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "rma-data-rma-search-result-interface": { - "type": "object", - "description": "Interface RmaSearchResultInterface", - "properties": { - "items": { - "type": "array", - "description": "Rma list", - "items": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "framework-metadata-object-interface": { - "type": "object", - "description": "Provides metadata about an attribute.", - "properties": { - "attribute_code": { - "type": "string", - "description": "Code of the attribute." - } - }, - "required": [ - "attribute_code" - ] - }, - "company-credit-data-credit-limit-search-results-interface": { - "type": "object", - "description": "Interface for Credit Limit search results.", - "properties": { - "items": { - "type": "array", - "description": "Credit Limit list.", - "items": { - "$ref": "#/definitions/company-credit-data-credit-data-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "company-credit-data-credit-data-interface": { - "type": "object", - "description": "Credit Data 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." - } - }, - "required": [ - "exceed_limit" - ] - }, - "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" - ] - }, - "company-credit-data-history-search-results-interface": { - "type": "object", - "description": "Interface for History search results.", - "properties": { - "items": { - "type": "array", - "description": "History list.", - "items": { - "$ref": "#/definitions/company-credit-data-history-data-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "company-credit-data-history-data-interface": { - "type": "object", - "description": "History data transfer object interface.", - "properties": { - "id": { - "type": "integer", - "description": "ID." - }, - "company_credit_id": { - "type": "integer", - "description": "Company credit id." - }, - "user_id": { - "type": "integer", - "description": "User Id." - }, - "user_type": { - "type": "integer", - "description": "User type: integration, admin, customer." - }, - "currency_credit": { - "type": "string", - "description": "Currency code of credit." - }, - "currency_operation": { - "type": "string", - "description": "Currency code of operation." - }, - "rate": { - "type": "number", - "description": "Currency rate between credit and operation currencies." - }, - "rate_credit": { - "type": "number", - "description": "Rate between credit and base currencies." - }, - "amount": { - "type": "number", - "description": "Amount." - }, - "balance": { - "type": "number", - "description": "Outstanding balance." - }, - "credit_limit": { - "type": "number", - "description": "Credit limit." - }, - "available_limit": { - "type": "number", - "description": "Available limit." - }, - "type": { - "type": "integer", - "description": "Type of operation." - }, - "datetime": { - "type": "string", - "description": "Operation datetime." - }, - "purchase_order": { - "type": "string", - "description": "Purchase Order number." - }, - "comment": { - "type": "string", - "description": "Comment." - } - }, - "required": [ - "rate", - "amount", - "balance", - "credit_limit" - ] - }, - "asynchronous-operations-data-detailed-bulk-operations-status-interface": { - "type": "object", - "description": "Interface BulkStatusInterface Bulk summary data with list of operations items full data.", - "properties": { - "operations_list": { - "type": "array", - "description": "Operations list.", - "items": { - "$ref": "#/definitions/asynchronous-operations-data-detailed-operation-status-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface" - }, - "bulk_id": { - "type": "string", - "description": "Bulk uuid" - }, - "description": { - "type": "string", - "description": "Bulk description" - }, - "start_time": { - "type": "string", - "description": "Bulk scheduled time" - }, - "user_id": { - "type": "integer", - "description": "User id" - }, - "operation_count": { - "type": "integer", - "description": "Total number of operations scheduled in scope of this bulk" - } - }, - "required": [ - "operations_list", - "bulk_id", - "description", - "start_time", - "user_id", - "operation_count" - ] - }, - "asynchronous-operations-data-detailed-operation-status-interface": { - "type": "object", - "description": "", - "properties": { - "result_serialized_data": { - "type": "string", - "description": "Serialized Data" - }, - "extension_attributes": { - "$ref": "#/definitions/asynchronous-operations-data-operation-extension-interface" - }, - "id": { - "type": "integer", - "description": "Id" - }, - "bulk_uuid": { - "type": "string", - "description": "Bulk uuid" - }, - "topic_name": { - "type": "string", - "description": "Queue Topic" - }, - "serialized_data": { - "type": "string", - "description": "Data" - }, - "status": { - "type": "integer", - "description": "Operation status" - }, - "result_message": { - "type": "string", - "description": "Result message" - }, - "error_code": { - "type": "integer", - "description": "Error code" - } - }, - "required": [ - "result_serialized_data", - "id", - "bulk_uuid", - "topic_name", - "serialized_data", - "status", - "result_message", - "error_code" - ] - }, - "asynchronous-operations-data-operation-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\OperationInterface" - }, - "asynchronous-operations-data-bulk-summary-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\BulkSummaryInterface" - }, - "asynchronous-operations-data-bulk-operations-status-interface": { - "type": "object", - "description": "Interface BulkStatusInterface Bulk summary data with list of operations items summary data.", - "properties": { - "operations_list": { - "type": "array", - "description": "List of operation with statuses (short data).", - "items": { - "$ref": "#/definitions/asynchronous-operations-data-summary-operation-status-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface" - }, - "bulk_id": { - "type": "string", - "description": "Bulk uuid" - }, - "description": { - "type": "string", - "description": "Bulk description" - }, - "start_time": { - "type": "string", - "description": "Bulk scheduled time" - }, - "user_id": { - "type": "integer", - "description": "User id" - }, - "operation_count": { - "type": "integer", - "description": "Total number of operations scheduled in scope of this bulk" - } - }, - "required": [ - "operations_list", - "bulk_id", - "description", - "start_time", - "user_id", - "operation_count" - ] - }, - "asynchronous-operations-data-summary-operation-status-interface": { - "type": "object", - "description": "Getter Class OperationsStatusInterface Instead of OperationInterface this class don't provide all operation data and not responsive to set any data, just to get operation data without serialized_data and result_serialized_data", - "properties": { - "id": { - "type": "integer", - "description": "Id" - }, - "status": { - "type": "integer", - "description": "Operation status" - }, - "result_message": { - "type": "string", - "description": "Result message" - }, - "error_code": { - "type": "integer", - "description": "Error code" - } - }, - "required": [ - "id", - "status", - "result_message", - "error_code" - ] - }, - "temando-shipping-data-collection-point-search-request-interface": { - "type": "object", - "description": "Temando Collection Point Search Request Interface", - "properties": { - "shipping_address_id": { - "type": "integer" - }, - "country_id": { - "type": "string" - }, - "postcode": { - "type": "string" - }, - "pending": { - "type": "boolean" - } - }, - "required": [ - "shipping_address_id", - "country_id", - "postcode", - "pending" - ] - }, - "temando-shipping-data-collection-point-quote-collection-point-interface": { - "type": "object", - "description": "Temando Quote Collection Point Interface – Checkout/Quoting", - "properties": { - "entity_id": { - "type": "integer" - }, - "collection_point_id": { - "type": "string" - }, - "recipient_address_id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "country": { - "type": "string" - }, - "region": { - "type": "string" - }, - "postcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "street": { - "type": "array", - "items": { - "type": "string" - } - }, - "opening_hours": { - "type": "array", - "items": { - "type": "string" - } - }, - "shipping_experiences": { - "type": "array", - "items": { - "type": "string" - } - }, - "selected": { - "type": "boolean" - } - }, - "required": [ - "entity_id", - "collection_point_id", - "recipient_address_id", - "name", - "country", - "region", - "postcode", - "city", - "street", - "opening_hours", - "shipping_experiences", - "selected" - ] - } - } -} \ No newline at end of file diff --git a/src/swagger/schemas/latest-2.0.schema.json b/src/swagger/schemas/latest-2.0.schema.json deleted file mode 100644 index dc07c30fa50..00000000000 --- a/src/swagger/schemas/latest-2.0.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.0","title":"Magento Enterprise Edition 2.0"},"host":"t2010.vg","basePath":"/rest/default","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":""},{"name":"searchV1","description":"Search API for all requests"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteGuestShipmentEstimationV1","description":"Interface GuestShipmentEstimationInterface"},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesRefundInvoiceV1","description":"Interface RefundInvoiceInterface"},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesRefundOrderV1","description":"Interface RefundOrderInterface"},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesShipOrderV1","description":"Class ShipOrderInterface"},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"salesInvoiceOrderV1","description":"Class InvoiceOrderInterface"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"customerBalanceBalanceManagementV1","description":"Customer balance(store credit) operations"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"giftCardAccountGiftCardAccountManagementV1","description":"Interface GiftCardAccountManagementInterface"},{"name":"giftCardAccountGuestGiftCardAccountManagementV1","description":""},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"},{"name":"giftRegistryShippingMethodManagementV1","description":""},{"name":"giftRegistryGuestCartShippingMethodManagementV1","description":""},{"name":"giftWrappingWrappingRepositoryV1","description":"Interface WrappingRepositoryInterface"},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"rewardRewardManagementV1","description":""},{"name":"rmaTrackManagementV1","description":"Interface TrackManagementInterface"},{"name":"rmaRmaRepositoryV1","description":"Interface RmaRepositoryInterface"},{"name":"rmaCommentManagementV1","description":"Interface CommentRepositoryInterface"},{"name":"rmaRmaManagementV1","description":"Interface RmaManagementInterface"},{"name":"rmaRmaAttributesManagementV1","description":"Interface RmaAttributesManagementInterface"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{id}":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","parameters":[{"name":"$body","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save custom option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save custom option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"$body","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoice/{invoiceId}/refund":{"post":{"tags":["salesRefundInvoiceV1"],"description":"Create refund for invoice","operationId":"salesRefundInvoiceV1ExecutePost","parameters":[{"name":"invoiceId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/refund":{"post":{"tags":["salesRefundOrderV1"],"description":"Create offline refund for order","operationId":"salesRefundOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/ship":{"post":{"tags":["salesShipOrderV1"],"description":"Creates new Shipment for given Order.","operationId":"salesShipOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Id of created Shipment."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/invoice":{"post":{"tags":["salesInvoiceOrderV1"],"description":"","operationId":"salesInvoiceOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/balance/apply":{"post":{"tags":["customerBalanceBalanceManagementV1"],"description":"Apply store credit","operationId":"customerBalanceBalanceManagementV1ApplyPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"$body","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"$body","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"$body","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/giftCards":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Return GiftCard Account cards","operationId":"giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards":{"put":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards":{"post":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards":{"post":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/giftregistry/mine/estimate-shipping-methods":{"post":{"tags":["giftRegistryShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":{"post":{"tags":["giftRegistryGuestCartShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{id}":{"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return data object for specified wrapping ID and store.","operationId":"giftWrappingWrappingRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Delete gift wrapping","operationId":"giftWrappingWrappingRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings":{"post":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return list of gift wrapping data objects based on search criteria This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#WrappingRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"giftWrappingWrappingRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{wrappingId}":{"put":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePut","parameters":[{"name":"wrappingId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/reward/mine/use-reward":{"post":{"tags":["rewardRewardManagementV1"],"description":"Set reward points to quote","operationId":"rewardRewardManagementV1SetPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers":{"post":{"tags":["rmaTrackManagementV1"],"description":"Add track","operationId":"rmaTrackManagementV1AddTrackPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["track"],"properties":{"track":{"$ref":"#/definitions/rma-data-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaTrackManagementV1"],"description":"Get track list","operationId":"rmaTrackManagementV1GetTracksGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-track-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers/{trackId}":{"delete":{"tags":["rmaTrackManagementV1"],"description":"Remove track by id","operationId":"rmaTrackManagementV1RemoveTrackByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"trackId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/labels":{"get":{"tags":["rmaTrackManagementV1"],"description":"Get shipping label int the PDF format","operationId":"rmaTrackManagementV1GetShippingLabelPdfGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}":{"get":{"tags":["rmaRmaRepositoryV1"],"description":"Return data object for specified RMA id","operationId":"rmaRmaRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["rmaRmaRepositoryV1"],"description":"Delete RMA","operationId":"rmaRmaRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/comments":{"post":{"tags":["rmaCommentManagementV1"],"description":"Add comment","operationId":"rmaCommentManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/rma-data-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaCommentManagementV1"],"description":"Comments list","operationId":"rmaCommentManagementV1CommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns":{"post":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPost","parameters":[{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaRmaManagementV1"],"description":"Return list of rma data objects based on search criteria","operationId":"rmaRmaManagementV1SearchGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/{attributeCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/form/{formCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve all attributes filtered by form code","operationId":"rmaRmaAttributesManagementV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get all attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/custom":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get custom attribute metadata for the given Data object's attribute set","operationId":"rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataObjectClassName","in":"query","type":"string","description":"Data object class name","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/framework-metadata-object-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"websiteId":{"type":"integer"},"storeGroupId":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","websiteId","storeGroupId"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"websiteId":{"type":"integer"},"rootCategoryId":{"type":"integer"},"defaultStoreId":{"type":"integer"},"name":{"type":"string"},"extensionAttributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","websiteId","rootCategoryId","defaultStoreId","name"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"defaultGroupId":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","defaultGroupId"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"websiteId":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"defaultDisplayCurrencyCode":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weightUnit":{"type":"string","description":"The unit of weight"},"baseUrl":{"type":"string","description":"Base URL for the store"},"baseLinkUrl":{"type":"string","description":"Base link URL for the store"},"baseStaticUrl":{"type":"string","description":"Base static URL for the store"},"baseMediaUrl":{"type":"string","description":"Base media URL for the store"},"secureBaseUrl":{"type":"string","description":"Secure base URL for the store"},"secureBaseLinkUrl":{"type":"string","description":"Secure base link URL for the store"},"secureBaseStaticUrl":{"type":"string","description":"Secure base static URL for the store"},"secureBaseMediaUrl":{"type":"string","description":"Secure base media URL for the store"},"extensionAttributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","websiteId","locale","baseCurrencyCode","defaultDisplayCurrencyCode","timezone","weightUnit","baseUrl","baseLinkUrl","baseStaticUrl","baseMediaUrl","secureBaseUrl","secureBaseLinkUrl","secureBaseStaticUrl","secureBaseMediaUrl"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"baseCurrencyCode":{"type":"string","description":"The base currency code for the store."},"baseCurrencySymbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"defaultDisplayCurrencyCode":{"type":"string","description":"The default display currency code for the store."},"defaultDisplayCurrencySymbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"availableCurrencyCodes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchangeRates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extensionAttributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["baseCurrencyCode","baseCurrencySymbol","defaultDisplayCurrencyCode","defaultDisplayCurrencySymbol","availableCurrencyCodes","exchangeRates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currencyTo":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extensionAttributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currencyTo","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"twoLetterAbbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"threeLetterAbbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"fullNameLocale":{"type":"string","description":"The country full name (in store locale) for the store."},"fullNameEnglish":{"type":"string","description":"The country full name (in English) for the store."},"availableRegions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extensionAttributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","twoLetterAbbreviation","threeLetterAbbreviation","fullNameLocale","fullNameEnglish"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extensionAttributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"eav-data-attribute-set-interface":{"type":"object","description":"","properties":{"attributeSetId":{"type":"integer","description":"Attribute set ID"},"attributeSetName":{"type":"string","description":"Attribute set name"},"sortOrder":{"type":"integer","description":"Attribute set sort order index"},"entityTypeId":{"type":"integer","description":"Attribute set entity type id"},"extensionAttributes":{"$ref":"#/definitions/eav-data-attribute-set-extension-interface"}},"required":["attributeSetName","sortOrder"]},"eav-data-attribute-set-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Eav\\Api\\Data\\AttributeSetInterface"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filterGroups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sortOrders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"pageSize":{"type":"integer","description":"Page size."},"currentPage":{"type":"integer","description":"Current page."}},"required":["filterGroups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"conditionType":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"customer-data-group-interface":{"type":"object","description":"Customer group interface.","properties":{"id":{"type":"integer","description":"Id"},"code":{"type":"string","description":"Code"},"taxClassId":{"type":"integer","description":"Tax class id"},"taxClassName":{"type":"string","description":"Tax class name"},"extensionAttributes":{"$ref":"#/definitions/customer-data-group-extension-interface"}},"required":["code","taxClassId"]},"customer-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\GroupInterface"},"customer-data-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontendInput":{"type":"string","description":"HTML for input element."},"inputFilter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"storeLabel":{"type":"string","description":"Label of the store."},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multilineCount":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"dataModel":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontendClass":{"type":"string","description":"Class which is used to display the attribute on frontend."},"userDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sortOrder":{"type":"integer","description":"Attributes sort order."},"frontendLabel":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backendType":{"type":"string","description":"Backend type."},"isUsedInGrid":{"type":"boolean","description":"It is used in customer grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in customer grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in customer grid"},"isSearchableInGrid":{"type":"boolean","description":"It is searchable in customer grid"},"attributeCode":{"type":"string","description":"Code of the attribute."}},"required":["frontendInput","inputFilter","storeLabel","validationRules","multilineCount","visible","required","dataModel","options","frontendClass","userDefined","sortOrder","frontendLabel","note","system","backendType","attributeCode"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"customer-data-customer-interface":{"type":"object","description":"Customer interface.","properties":{"id":{"type":"integer","description":"Customer id"},"groupId":{"type":"integer","description":"Group id"},"defaultBilling":{"type":"string","description":"Default billing address id"},"defaultShipping":{"type":"string","description":"Default shipping address id"},"confirmation":{"type":"string","description":"Confirmation"},"createdAt":{"type":"string","description":"Created at time"},"updatedAt":{"type":"string","description":"Updated at time"},"createdIn":{"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"},"storeId":{"type":"integer","description":"Store id"},"taxvat":{"type":"string","description":"Tax Vat"},"websiteId":{"type":"integer","description":"Website id"},"addresses":{"type":"array","description":"Customer addresses.","items":{"$ref":"#/definitions/customer-data-address-interface"}},"disableAutoGroupChange":{"type":"integer","description":"Disable auto group change flag."},"extensionAttributes":{"$ref":"#/definitions/customer-data-customer-extension-interface"},"customAttributes":{"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"},"customerId":{"type":"integer","description":"Customer ID"},"region":{"$ref":"#/definitions/customer-data-region-interface"},"regionId":{"type":"integer","description":"Region ID"},"countryId":{"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"},"vatId":{"type":"string","description":"Vat id"},"defaultShipping":{"type":"boolean","description":"If this address is default shipping address."},"defaultBilling":{"type":"boolean","description":"If this address is default billing address"},"extensionAttributes":{"$ref":"#/definitions/customer-data-address-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"customer-data-region-interface":{"type":"object","description":"Customer address region interface.","properties":{"regionCode":{"type":"string","description":"Region code"},"region":{"type":"string","description":"Region"},"regionId":{"type":"integer","description":"Region id"},"extensionAttributes":{"$ref":"#/definitions/customer-data-region-extension-interface"}},"required":["regionCode","region","regionId"]},"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":{"attributeCode":{"type":"string","description":"Attribute code"},"value":{"type":"string","description":"Attribute value"}},"required":["attributeCode","value"]},"customer-data-customer-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\CustomerInterface"},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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"},"pageLayout":{"type":"string","description":"Page layout"},"metaKeywords":{"type":"string","description":"Meta keywords"},"metaDescription":{"type":"string","description":"Meta description"},"contentHeading":{"type":"string","description":"Content heading"},"content":{"type":"string","description":"Content"},"creationTime":{"type":"string","description":"Creation time"},"updateTime":{"type":"string","description":"Update time"},"sortOrder":{"type":"string","description":"Sort order"},"layoutUpdateXml":{"type":"string","description":"Layout update xml"},"customTheme":{"type":"string","description":"Custom theme"},"customRootTemplate":{"type":"string","description":"Custom root template"},"customLayoutUpdateXml":{"type":"string","description":"Custom layout update xml"},"customThemeFrom":{"type":"string","description":"Custom theme from"},"customThemeTo":{"type":"string","description":"Custom theme to"},"active":{"type":"boolean","description":"Active"}},"required":["identifier"]},"cms-data-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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"},"creationTime":{"type":"string","description":"Creation time"},"updateTime":{"type":"string","description":"Update time"},"active":{"type":"boolean","description":"Active"}},"required":["identifier"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Id"},"sku":{"type":"string","description":"Sku"},"name":{"type":"string","description":"Name"},"attributeSetId":{"type":"integer","description":"Attribute set id"},"price":{"type":"number","description":"Price"},"status":{"type":"integer","description":"Status"},"visibility":{"type":"integer","description":"Visibility"},"typeId":{"type":"string","description":"Type id"},"createdAt":{"type":"string","description":"Created date"},"updatedAt":{"type":"string","description":"Updated date"},"weight":{"type":"number","description":"Weight"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-extension-interface"},"productLinks":{"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"}},"mediaGalleryEntries":{"type":"array","description":"Media gallery entries","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"tierPrices":{"type":"array","description":"List of product tier prices","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}},"customAttributes":{"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":{"downloadableProductLinks":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}},"downloadableProductSamples":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}},"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"giftcardAmounts":{"type":"array","items":{"$ref":"#/definitions/gift-card-data-giftcard-amount-interface"}},"configurableProductOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"configurableProductLinks":{"type":"array","items":{"type":"integer"}},"bundleProductOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}}},"downloadable-data-link-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Sample(or link) id"},"title":{"type":"string"},"sortOrder":{"type":"integer"},"isShareable":{"type":"integer","description":"Shareable status"},"price":{"type":"number","description":"Price"},"numberOfDownloads":{"type":"integer","description":"Of downloads per user"},"linkType":{"type":"string"},"linkFile":{"type":"string","description":"relative file path"},"linkFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"linkUrl":{"type":"string","description":"Link url or null when type is 'file'"},"sampleType":{"type":"string"},"sampleFile":{"type":"string","description":"relative file path"},"sampleFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"sampleUrl":{"type":"string","description":"file URL"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-link-extension-interface"}},"required":["sortOrder","isShareable","price","linkType","sampleType"]},"downloadable-data-file-content-interface":{"type":"object","description":"","properties":{"fileData":{"type":"string","description":"Data (base64 encoded content)"},"name":{"type":"string","description":"File name"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-file-content-extension-interface"}},"required":["fileData","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"},"sortOrder":{"type":"integer","description":"Order index for sample"},"sampleType":{"type":"string"},"sampleFile":{"type":"string","description":"relative file path"},"sampleFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"sampleUrl":{"type":"string","description":"file URL"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-sample-extension-interface"}},"required":["title","sortOrder","sampleType"]},"downloadable-data-sample-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Downloadable\\Api\\Data\\SampleInterface"},"catalog-inventory-data-stock-item-interface":{"type":"object","description":"Interface StockItem","properties":{"itemId":{"type":"integer"},"productId":{"type":"integer"},"stockId":{"type":"integer","description":"Stock identifier"},"qty":{"type":"number"},"isInStock":{"type":"boolean","description":"Stock Availability"},"isQtyDecimal":{"type":"boolean"},"showDefaultNotificationMessage":{"type":"boolean"},"useConfigMinQty":{"type":"boolean"},"minQty":{"type":"number","description":"Minimal quantity available for item status in stock"},"useConfigMinSaleQty":{"type":"integer"},"minSaleQty":{"type":"number","description":"Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation"},"useConfigMaxSaleQty":{"type":"boolean"},"maxSaleQty":{"type":"number","description":"Maximum Qty Allowed in Shopping Cart data wrapper"},"useConfigBackorders":{"type":"boolean"},"backorders":{"type":"integer","description":"Backorders status"},"useConfigNotifyStockQty":{"type":"boolean"},"notifyStockQty":{"type":"number","description":"Notify for Quantity Below data wrapper"},"useConfigQtyIncrements":{"type":"boolean"},"qtyIncrements":{"type":"number","description":"Quantity Increments data wrapper"},"useConfigEnableQtyInc":{"type":"boolean"},"enableQtyIncrements":{"type":"boolean","description":"Whether Quantity Increments is enabled"},"useConfigManageStock":{"type":"boolean"},"manageStock":{"type":"boolean","description":"Can Manage Stock"},"lowStockDate":{"type":"string"},"isDecimalDivided":{"type":"boolean"},"stockStatusChangedAuto":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/catalog-inventory-data-stock-item-extension-interface"}},"required":["qty","isInStock","isQtyDecimal","showDefaultNotificationMessage","useConfigMinQty","minQty","useConfigMinSaleQty","minSaleQty","useConfigMaxSaleQty","maxSaleQty","useConfigBackorders","backorders","useConfigNotifyStockQty","notifyStockQty","useConfigQtyIncrements","qtyIncrements","useConfigEnableQtyInc","enableQtyIncrements","useConfigManageStock","manageStock","lowStockDate","isDecimalDivided","stockStatusChangedAuto"]},"catalog-inventory-data-stock-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockItemInterface"},"gift-card-data-giftcard-amount-interface":{"type":"object","description":"Interface GiftcardAmountInterface: this interface is used to serialize and deserialize EAV attribute giftcard_amounts","properties":{"websiteId":{"type":"integer"},"value":{"type":"number"},"websiteValue":{"type":"number"},"extensionAttributes":{"$ref":"#/definitions/gift-card-data-giftcard-amount-extension-interface"}},"required":["websiteId","value","websiteValue"]},"gift-card-data-giftcard-amount-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCard\\Api\\Data\\GiftcardAmountInterface"},"configurable-product-data-option-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"attributeId":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"},"isUseDefault":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-value-interface"}},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-option-extension-interface"},"productId":{"type":"integer"}}},"configurable-product-data-option-value-interface":{"type":"object","description":"","properties":{"valueIndex":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-option-value-extension-interface"}},"required":["valueIndex"]},"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"},"bundle-data-option-interface":{"type":"object","description":"Interface OptionInterface","properties":{"optionId":{"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"},"productLinks":{"type":"array","description":"Product links","items":{"$ref":"#/definitions/bundle-data-link-interface"}},"extensionAttributes":{"$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"},"optionId":{"type":"integer","description":"Option id"},"qty":{"type":"number","description":"Qty"},"position":{"type":"integer","description":"Position"},"isDefault":{"type":"boolean","description":"Is default"},"price":{"type":"number","description":"Price"},"priceType":{"type":"integer","description":"Price type"},"canChangeQuantity":{"type":"integer","description":"Whether quantity could be changed"},"extensionAttributes":{"$ref":"#/definitions/bundle-data-link-extension-interface"}},"required":["isDefault","price","priceType"]},"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"},"catalog-data-product-link-interface":{"type":"object","description":"","properties":{"sku":{"type":"string","description":"SKU"},"linkType":{"type":"string","description":"Link type"},"linkedProductSku":{"type":"string","description":"Linked product sku"},"linkedProductType":{"type":"string","description":"Linked product type (simple, virtual, etc)"},"position":{"type":"integer","description":"Linked item position"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-extension-interface"}},"required":["sku","linkType","linkedProductSku","linkedProductType","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":{"productSku":{"type":"string","description":"Product SKU"},"optionId":{"type":"integer","description":"Option id"},"title":{"type":"string","description":"Option title"},"type":{"type":"string","description":"Option type"},"sortOrder":{"type":"integer","description":"Sort order"},"isRequire":{"type":"boolean","description":"Is require"},"price":{"type":"number","description":"Price"},"priceType":{"type":"string","description":"Price type"},"sku":{"type":"string","description":"Sku"},"fileExtension":{"type":"string"},"maxCharacters":{"type":"integer"},"imageSizeX":{"type":"integer"},"imageSizeY":{"type":"integer"},"values":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-values-interface"}},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-custom-option-extension-interface"}},"required":["productSku","title","type","sortOrder","isRequire"]},"catalog-data-product-custom-option-values-interface":{"type":"object","description":"","properties":{"title":{"type":"string","description":"Option title"},"sortOrder":{"type":"integer","description":"Sort order"},"price":{"type":"number","description":"Price"},"priceType":{"type":"string","description":"Price type"},"sku":{"type":"string","description":"Sku"},"optionTypeId":{"type":"integer","description":"Option type id"}},"required":["title","sortOrder","price","priceType"]},"catalog-data-product-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionInterface"},"catalog-data-product-attribute-media-gallery-entry-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Gallery entry ID"},"mediaType":{"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"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-extension-interface"}},"required":["mediaType","label","position","disabled","types"]},"framework-data-image-content-interface":{"type":"object","description":"Image Content data interface","properties":{"base64EncodedData":{"type":"string","description":"Media data (base64 encoded content)"},"type":{"type":"string","description":"MIME type"},"name":{"type":"string","description":"Image name"}},"required":["base64EncodedData","type","name"]},"catalog-data-product-attribute-media-gallery-entry-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeMediaGalleryEntryInterface","properties":{"videoContent":{"$ref":"#/definitions/framework-data-video-content-interface"}}},"framework-data-video-content-interface":{"type":"object","description":"Video Content data interface","properties":{"mediaType":{"type":"string","description":"MIME type"},"videoProvider":{"type":"string","description":"Provider"},"videoUrl":{"type":"string","description":"Video URL"},"videoTitle":{"type":"string","description":"Title"},"videoDescription":{"type":"string","description":"Video Description"},"videoMetadata":{"type":"string","description":"Metadata"}},"required":["mediaType","videoProvider","videoUrl","videoTitle","videoDescription","videoMetadata"]},"catalog-data-product-tier-price-interface":{"type":"object","description":"","properties":{"customerGroupId":{"type":"integer","description":"Customer group id"},"qty":{"type":"number","description":"Tier qty"},"value":{"type":"number","description":"Price value"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-tier-price-extension-interface"}},"required":["customerGroupId","qty","value"]},"catalog-data-product-tier-price-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTierPriceInterface"},"catalog-data-product-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"isWysiwygEnabled":{"type":"boolean","description":"WYSIWYG flag"},"isHtmlAllowedOnFront":{"type":"boolean","description":"The HTML tags are allowed on the frontend"},"usedForSortBy":{"type":"boolean","description":"It is used for sorting in product listing"},"isFilterable":{"type":"boolean","description":"It used in layered navigation"},"isFilterableInSearch":{"type":"boolean","description":"It is used in search results layered navigation"},"isUsedInGrid":{"type":"boolean","description":"It is used in catalog product grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in catalog product grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in catalog product grid"},"position":{"type":"integer","description":"Position"},"applyTo":{"type":"array","description":"Apply to value for the element","items":{"type":"string"}},"isSearchable":{"type":"string","description":"The attribute can be used in Quick Search"},"isVisibleInAdvancedSearch":{"type":"string","description":"The attribute can be used in Advanced Search"},"isComparable":{"type":"string","description":"The attribute can be compared on the frontend"},"isUsedForPromoRules":{"type":"string","description":"The attribute can be used for promo rules"},"isVisibleOnFront":{"type":"string","description":"The attribute is visible on the frontend"},"usedInProductListing":{"type":"string","description":"The attribute can be used in product listing"},"isVisible":{"type":"boolean","description":"Attribute is visible on frontend."},"scope":{"type":"string","description":"Attribute scope"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"attributeId":{"type":"integer","description":"Id of the attribute."},"attributeCode":{"type":"string","description":"Code of the attribute."},"frontendInput":{"type":"string","description":"HTML for input element."},"entityTypeId":{"type":"string","description":"Entity type id"},"isRequired":{"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"}},"isUserDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"defaultFrontendLabel":{"type":"string","description":"Frontend label for default store"},"frontendLabels":{"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."},"backendType":{"type":"string","description":"Backend type."},"backendModel":{"type":"string","description":"Backend model"},"sourceModel":{"type":"string","description":"Source model"},"defaultValue":{"type":"string","description":"Default value for the element."},"isUnique":{"type":"string","description":"This is a unique attribute"},"frontendClass":{"type":"string","description":"Frontend class of attribute"},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/eav-data-attribute-validation-rule-interface"}},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["attributeCode","frontendInput","isRequired","frontendLabels"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"eav-data-attribute-option-interface":{"type":"object","description":"Created from:","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"sortOrder":{"type":"integer","description":"Option order"},"isDefault":{"type":"boolean","description":"Default"},"storeLabels":{"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":"","properties":{"storeId":{"type":"integer","description":"Store id"},"label":{"type":"string","description":"Option label"}}},"eav-data-attribute-frontend-label-interface":{"type":"object","description":"","properties":{"storeId":{"type":"integer","description":"Store id"},"label":{"type":"string","description":"Option label"}}},"eav-data-attribute-validation-rule-interface":{"type":"object","description":"","properties":{"key":{"type":"string","description":"Object key"},"value":{"type":"string","description":"Object value"}},"required":["key","value"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"isWysiwygEnabled":{"type":"boolean","description":"WYSIWYG flag"},"isHtmlAllowedOnFront":{"type":"boolean","description":"The HTML tags are allowed on the frontend"},"usedForSortBy":{"type":"boolean","description":"It is used for sorting in product listing"},"isFilterable":{"type":"boolean","description":"It used in layered navigation"},"isFilterableInSearch":{"type":"boolean","description":"It is used in search results layered navigation"},"isUsedInGrid":{"type":"boolean","description":"It is used in catalog product grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in catalog product grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in catalog product grid"},"position":{"type":"integer","description":"Position"},"applyTo":{"type":"array","description":"Apply to value for the element","items":{"type":"string"}},"isSearchable":{"type":"string","description":"The attribute can be used in Quick Search"},"isVisibleInAdvancedSearch":{"type":"string","description":"The attribute can be used in Advanced Search"},"isComparable":{"type":"string","description":"The attribute can be compared on the frontend"},"isUsedForPromoRules":{"type":"string","description":"The attribute can be used for promo rules"},"isVisibleOnFront":{"type":"string","description":"The attribute is visible on the frontend"},"usedInProductListing":{"type":"string","description":"The attribute can be used in product listing"},"isVisible":{"type":"boolean","description":"Attribute is visible on frontend."},"scope":{"type":"string","description":"Attribute scope"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"attributeId":{"type":"integer","description":"Id of the attribute."},"attributeCode":{"type":"string","description":"Code of the attribute."},"frontendInput":{"type":"string","description":"HTML for input element."},"entityTypeId":{"type":"string","description":"Entity type id"},"isRequired":{"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"}},"isUserDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"defaultFrontendLabel":{"type":"string","description":"Frontend label for default store"},"frontendLabels":{"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."},"backendType":{"type":"string","description":"Backend type."},"backendModel":{"type":"string","description":"Backend model"},"sourceModel":{"type":"string","description":"Source model"},"defaultValue":{"type":"string","description":"Default value for the element."},"isUnique":{"type":"string","description":"This is a unique attribute"},"frontendClass":{"type":"string","description":"Frontend class of attribute"},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/eav-data-attribute-validation-rule-interface"}},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["attributeCode","frontendInput","isRequired","frontendLabels"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"eav-data-attribute-group-interface":{"type":"object","description":"","properties":{"attributeGroupId":{"type":"string","description":"Id"},"attributeGroupName":{"type":"string","description":"Name"},"attributeSetId":{"type":"integer","description":"Attribute set id"},"extensionAttributes":{"$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"},"catalog-data-category-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"parentId":{"type":"integer","description":"Parent category ID"},"name":{"type":"string","description":"Category name"},"isActive":{"type":"boolean","description":"Whether category is active"},"position":{"type":"integer","description":"Category position"},"level":{"type":"integer","description":"Category level"},"children":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"path":{"type":"string"},"availableSortBy":{"type":"array","items":{"type":"string"}},"includeInMenu":{"type":"boolean"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"parentId":{"type":"integer","description":"Parent category ID"},"name":{"type":"string","description":"Category name"},"isActive":{"type":"boolean","description":"Whether category is active"},"position":{"type":"integer","description":"Category position"},"level":{"type":"integer","description":"Category level"},"productCount":{"type":"integer","description":"Product count"},"childrenData":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parentId","name","isActive","position","level","productCount","childrenData"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"catalog-data-category-product-link-interface":{"type":"object","description":"","properties":{"sku":{"type":"string"},"position":{"type":"integer"},"categoryId":{"type":"string","description":"Category id"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-category-product-link-extension-interface"}},"required":["categoryId"]},"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"},"websiteId":{"type":"integer","description":"Website ids"}},"required":["sku","websiteId"]},"framework-search-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"searchCriteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","aggregations","searchCriteria","totalCount"]},"framework-search-document-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucketNames":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucketNames"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"","properties":{"requestName":{"type":"string"},"filterGroups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sortOrders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"pageSize":{"type":"integer","description":"Page size."},"currentPage":{"type":"integer","description":"Current page."}},"required":["requestName","filterGroups"]},"quote-data-cart-interface":{"type":"object","description":"Interface CartInterface","properties":{"id":{"type":"integer","description":"Cart/quote ID."},"createdAt":{"type":"string","description":"Cart creation date and time. Otherwise, null."},"updatedAt":{"type":"string","description":"Cart last update date and time. Otherwise, null."},"convertedAt":{"type":"string","description":"Cart conversion date and time. Otherwise, null."},"isActive":{"type":"boolean","description":"Active status flag value. Otherwise, null."},"isVirtual":{"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"}},"itemsCount":{"type":"integer","description":"Number of different items or products in the cart. Otherwise, null."},"itemsQty":{"type":"number","description":"Total quantity of all cart items. Otherwise, null."},"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"reservedOrderId":{"type":"integer","description":"Reserved order ID. Otherwise, null."},"origOrderId":{"type":"integer","description":"Original order ID. Otherwise, null."},"currency":{"$ref":"#/definitions/quote-data-currency-interface"},"customerIsGuest":{"type":"boolean","description":"For guest customers, false for logged in customers"},"customerNote":{"type":"string","description":"Notice text"},"customerNoteNotify":{"type":"boolean","description":"Customer notification flag"},"customerTaxClassId":{"type":"integer","description":"Customer tax class ID."},"storeId":{"type":"integer","description":"Store identifier"},"extensionAttributes":{"$ref":"#/definitions/quote-data-cart-extension-interface"}},"required":["id","customer","storeId"]},"quote-data-cart-item-interface":{"type":"object","description":"Interface CartItemInterface","properties":{"itemId":{"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."},"productType":{"type":"string","description":"Product type. Otherwise, null."},"quoteId":{"type":"string","description":"Quote id."},"productOption":{"$ref":"#/definitions/quote-data-product-option-interface"},"extensionAttributes":{"$ref":"#/definitions/quote-data-cart-item-extension-interface"}},"required":["qty","quoteId"]},"quote-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extensionAttributes":{"$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":{"customOptions":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"downloadableOption":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcardItemOption":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"},"configurableItemOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}},"bundleOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}}}},"catalog-data-custom-option-interface":{"type":"object","description":"Interface CustomOptionInterface","properties":{"optionId":{"type":"string","description":"Option id"},"optionValue":{"type":"string","description":"Option value"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-custom-option-extension-interface"}},"required":["optionId","optionValue"]},"catalog-data-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CustomOptionInterface","properties":{"fileInfo":{"$ref":"#/definitions/framework-data-image-content-interface"}}},"downloadable-data-downloadable-option-interface":{"type":"object","description":"Downloadable Option","properties":{"downloadableLinks":{"type":"array","description":"The list of downloadable links","items":{"type":"integer"}}},"required":["downloadableLinks"]},"gift-card-data-gift-card-option-interface":{"type":"object","description":"Interface GiftCardOptionInterface","properties":{"giftcardAmount":{"type":"number","description":"Gift card amount."},"customGiftcardAmount":{"type":"number","description":"Gift card open amount value."},"giftcardSenderName":{"type":"string","description":"Gift card sender name."},"giftcardRecipientName":{"type":"string","description":"Gift card recipient name."},"giftcardSenderEmail":{"type":"string","description":"Gift card sender email."},"giftcardRecipientEmail":{"type":"string","description":"Gift card recipient email."},"giftcardMessage":{"type":"string","description":"Giftcard message."},"extensionAttributes":{"$ref":"#/definitions/gift-card-data-gift-card-option-extension-interface"}},"required":["giftcardAmount","giftcardSenderName","giftcardRecipientName","giftcardSenderEmail","giftcardRecipientEmail"]},"gift-card-data-gift-card-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCard\\Api\\Data\\GiftCardOptionInterface"},"configurable-product-data-configurable-item-option-value-interface":{"type":"object","description":"Interface ConfigurableItemOptionValueInterface","properties":{"optionId":{"type":"string","description":"Option SKU"},"optionValue":{"type":"integer","description":"Item id"},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-extension-interface"}},"required":["optionId"]},"configurable-product-data-configurable-item-option-value-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\ConfigurableProduct\\Api\\Data\\ConfigurableItemOptionValueInterface"},"bundle-data-bundle-option-interface":{"type":"object","description":"Interface BundleOptionInterface","properties":{"optionId":{"type":"integer","description":"Bundle option id."},"optionQty":{"type":"integer","description":"Bundle option quantity."},"optionSelections":{"type":"array","description":"Bundle option selection ids.","items":{"type":"integer"}},"extensionAttributes":{"$ref":"#/definitions/bundle-data-bundle-option-extension-interface"}},"required":["optionId","optionQty","optionSelections"]},"bundle-data-bundle-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\BundleOptionInterface"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface"},"quote-data-address-interface":{"type":"object","description":"Interface AddressInterface","properties":{"id":{"type":"integer","description":"Id"},"region":{"type":"string","description":"Region name"},"regionId":{"type":"integer","description":"Region id"},"regionCode":{"type":"string","description":"Region code"},"countryId":{"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"},"vatId":{"type":"string","description":"Vat id"},"customerId":{"type":"integer","description":"Customer id"},"email":{"type":"string","description":"Billing/shipping email"},"sameAsBilling":{"type":"integer","description":"Same as billing flag"},"customerAddressId":{"type":"integer","description":"Customer address id"},"saveInAddressBook":{"type":"integer","description":"Save in address book flag"},"extensionAttributes":{"$ref":"#/definitions/quote-data-address-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["region","regionId","regionCode","countryId","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":{"giftRegistryId":{"type":"integer"}}},"quote-data-currency-interface":{"type":"object","description":"Interface CurrencyInterface","properties":{"globalCurrencyCode":{"type":"string","description":"Global currency code"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"storeCurrencyCode":{"type":"string","description":"Store currency code"},"quoteCurrencyCode":{"type":"string","description":"Quote currency code"},"storeToBaseRate":{"type":"number","description":"Store currency to base currency rate"},"storeToQuoteRate":{"type":"number","description":"Store currency to quote currency rate"},"baseToGlobalRate":{"type":"number","description":"Base currency to global currency rate"},"baseToQuoteRate":{"type":"number","description":"Base currency to quote currency rate"},"extensionAttributes":{"$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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"quote-data-payment-interface":{"type":"object","description":"Interface PaymentInterface","properties":{"poNumber":{"type":"string","description":"Purchase order number"},"method":{"type":"string","description":"Payment method code"},"additionalData":{"type":"array","description":"Payment additional details","items":{"type":"string"}},"extensionAttributes":{"$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":{"agreementIds":{"type":"array","items":{"type":"string"}}}},"quote-data-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrierCode":{"type":"string","description":"Shipping carrier code."},"methodCode":{"type":"string","description":"Shipping method code."},"carrierTitle":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"methodTitle":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"baseAmount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extensionAttributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"errorMessage":{"type":"string","description":"Shipping Error message."},"priceExclTax":{"type":"number","description":"Shipping price excl tax."},"priceInclTax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrierCode","methodCode","amount","baseAmount","available","errorMessage","priceExclTax","priceInclTax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grandTotal":{"type":"number","description":"Grand total in quote currency"},"baseGrandTotal":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"baseSubtotal":{"type":"number","description":"Subtotal in base currency"},"discountAmount":{"type":"number","description":"Discount amount in quote currency"},"baseDiscountAmount":{"type":"number","description":"Discount amount in base currency"},"subtotalWithDiscount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"baseSubtotalWithDiscount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shippingAmount":{"type":"number","description":"Shipping amount in quote currency"},"baseShippingAmount":{"type":"number","description":"Shipping amount in base currency"},"shippingDiscountAmount":{"type":"number","description":"Shipping discount amount in quote currency"},"baseShippingDiscountAmount":{"type":"number","description":"Shipping discount amount in base currency"},"taxAmount":{"type":"number","description":"Tax amount in quote currency"},"baseTaxAmount":{"type":"number","description":"Tax amount in base currency"},"weeeTaxAppliedAmount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount in quote currency"},"baseShippingTaxAmount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotalInclTax":{"type":"number","description":"Subtotal including tax in quote currency"},"baseSubtotalInclTax":{"type":"number","description":"Subtotal including tax in base currency"},"shippingInclTax":{"type":"number","description":"Shipping including tax in quote currency"},"baseShippingInclTax":{"type":"number","description":"Shipping including tax in base currency"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"quoteCurrencyCode":{"type":"string","description":"Quote currency code"},"couponCode":{"type":"string","description":"Applied coupon code"},"itemsQty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"totalSegments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weeeTaxAppliedAmount","totalSegments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"itemId":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"basePrice":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"rowTotal":{"type":"number","description":"Row total in quote currency."},"baseRowTotal":{"type":"number","description":"Row total in base currency."},"rowTotalWithDiscount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"taxAmount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"baseTaxAmount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"taxPercent":{"type":"number","description":"Tax percent. Otherwise, null."},"discountAmount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"baseDiscountAmount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discountPercent":{"type":"number","description":"Discount percent. Otherwise, null."},"priceInclTax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"basePriceInclTax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"rowTotalInclTax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"baseRowTotalInclTax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weeeTaxAppliedAmount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weeeTaxApplied":{"type":"string","description":"Item weee tax applied in quote currency."},"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["itemId","price","basePrice","qty","rowTotal","baseRowTotal","options","weeeTaxAppliedAmount","weeeTaxApplied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extensionAttributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"taxGrandtotalDetails":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}},"giftCards":{"type":"string"},"gwOrderId":{"type":"string"},"gwItemIds":{"type":"array","items":{"type":"string"}},"gwAllowGiftReceipt":{"type":"string"},"gwAddCard":{"type":"string"},"gwPrice":{"type":"string"},"gwBasePrice":{"type":"string"},"gwItemsPrice":{"type":"string"},"gwItemsBasePrice":{"type":"string"},"gwCardPrice":{"type":"string"},"gwCardBasePrice":{"type":"string"},"gwBaseTaxAmount":{"type":"string"},"gwTaxAmount":{"type":"string"},"gwItemsBaseTaxAmount":{"type":"string"},"gwItemsTaxAmount":{"type":"string"},"gwCardBaseTaxAmount":{"type":"string"},"gwCardTaxAmount":{"type":"string"},"gwPriceInclTax":{"type":"string"},"gwBasePriceInclTax":{"type":"string"},"gwCardPriceInclTax":{"type":"string"},"gwCardBasePriceInclTax":{"type":"string"},"gwItemsPriceInclTax":{"type":"string"},"gwItemsBasePriceInclTax":{"type":"string"}}},"tax-data-grand-total-details-interface":{"type":"object","description":"","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"groupId":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","groupId"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface","properties":{"rewardPointsBalance":{"type":"number"},"rewardCurrencyAmount":{"type":"number"},"baseRewardCurrencyAmount":{"type":"number"}}},"quote-data-totals-additional-data-interface":{"type":"object","description":"Additional data for totals collection.","properties":{"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-additional-data-extension-interface"},"customAttributes":{"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":{"giftMessages":{"type":"array","items":{"$ref":"#/definitions/gift-message-data-message-interface"}}}},"gift-message-data-message-interface":{"type":"object","description":"","properties":{"giftMessageId":{"type":"integer","description":"Gift message ID. Otherwise, null."},"customerId":{"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."},"extensionAttributes":{"$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":{"entityId":{"type":"string"},"entityType":{"type":"string"},"wrappingId":{"type":"integer"},"wrappingAllowGiftReceipt":{"type":"boolean"},"wrappingAddPrintedCard":{"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":{"adjustmentNegative":{"type":"number","description":"Negative adjustment value."},"adjustmentPositive":{"type":"number","description":"Positive adjustment value."},"appliedRuleIds":{"type":"string","description":"Applied rule IDs."},"baseAdjustmentNegative":{"type":"number","description":"Base negative adjustment value."},"baseAdjustmentPositive":{"type":"number","description":"Base positive adjustment value."},"baseCurrencyCode":{"type":"string","description":"Base currency code."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountCanceled":{"type":"number","description":"Base discount canceled."},"baseDiscountInvoiced":{"type":"number","description":"Base discount invoiced."},"baseDiscountRefunded":{"type":"number","description":"Base discount refunded."},"baseGrandTotal":{"type":"number","description":"Base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseDiscountTaxCompensationInvoiced":{"type":"number","description":"Base discount tax compensation invoiced."},"baseDiscountTaxCompensationRefunded":{"type":"number","description":"Base discount tax compensation refunded."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingCanceled":{"type":"number","description":"Base shipping canceled."},"baseShippingDiscountAmount":{"type":"number","description":"Base shipping discount amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Base shipping including tax."},"baseShippingInvoiced":{"type":"number","description":"Base shipping invoiced."},"baseShippingRefunded":{"type":"number","description":"Base shipping refunded."},"baseShippingTaxAmount":{"type":"number","description":"Base shipping tax amount."},"baseShippingTaxRefunded":{"type":"number","description":"Base shipping tax refunded."},"baseSubtotal":{"type":"number","description":"Base subtotal."},"baseSubtotalCanceled":{"type":"number","description":"Base subtotal canceled."},"baseSubtotalInclTax":{"type":"number","description":"Base subtotal including tax."},"baseSubtotalInvoiced":{"type":"number","description":"Base subtotal invoiced."},"baseSubtotalRefunded":{"type":"number","description":"Base subtotal refunded."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTaxCanceled":{"type":"number","description":"Base tax canceled."},"baseTaxInvoiced":{"type":"number","description":"Base tax invoiced."},"baseTaxRefunded":{"type":"number","description":"Base tax refunded."},"baseTotalCanceled":{"type":"number","description":"Base total canceled."},"baseTotalDue":{"type":"number","description":"Base total due."},"baseTotalInvoiced":{"type":"number","description":"Base total invoiced."},"baseTotalInvoicedCost":{"type":"number","description":"Base total invoiced cost."},"baseTotalOfflineRefunded":{"type":"number","description":"Base total offline refunded."},"baseTotalOnlineRefunded":{"type":"number","description":"Base total online refunded."},"baseTotalPaid":{"type":"number","description":"Base total paid."},"baseTotalQtyOrdered":{"type":"number","description":"Base total quantity ordered."},"baseTotalRefunded":{"type":"number","description":"Base total refunded."},"baseToGlobalRate":{"type":"number","description":"Base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Base-to-order rate."},"billingAddressId":{"type":"integer","description":"Billing address ID."},"canShipPartially":{"type":"integer","description":"Can-ship-partially flag value."},"canShipPartiallyItem":{"type":"integer","description":"Can-ship-partially-item flag value."},"couponCode":{"type":"string","description":"Coupon code."},"createdAt":{"type":"string","description":"Created-at timestamp."},"customerDob":{"type":"string","description":"Customer date-of-birth (DOB)."},"customerEmail":{"type":"string","description":"Customer email address."},"customerFirstname":{"type":"string","description":"Customer first name."},"customerGender":{"type":"integer","description":"Customer gender."},"customerGroupId":{"type":"integer","description":"Customer group ID."},"customerId":{"type":"integer","description":"Customer ID."},"customerIsGuest":{"type":"integer","description":"Customer-is-guest flag value."},"customerLastname":{"type":"string","description":"Customer last name."},"customerMiddlename":{"type":"string","description":"Customer middle name."},"customerNote":{"type":"string","description":"Customer note."},"customerNoteNotify":{"type":"integer","description":"Customer-note-notify flag value."},"customerPrefix":{"type":"string","description":"Customer prefix."},"customerSuffix":{"type":"string","description":"Customer suffix."},"customerTaxvat":{"type":"string","description":"Customer value-added tax (VAT)."},"discountAmount":{"type":"number","description":"Discount amount."},"discountCanceled":{"type":"number","description":"Discount canceled."},"discountDescription":{"type":"string","description":"Discount description."},"discountInvoiced":{"type":"number","description":"Discount invoiced."},"discountRefunded":{"type":"number","description":"Discount refunded amount."},"editIncrement":{"type":"integer","description":"Edit increment value."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Order ID."},"extCustomerId":{"type":"string","description":"External customer ID."},"extOrderId":{"type":"string","description":"External order ID."},"forcedShipmentWithInvoice":{"type":"integer","description":"Forced-shipment-with-invoice flag value."},"globalCurrencyCode":{"type":"string","description":"Global currency code."},"grandTotal":{"type":"number","description":"Grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"discountTaxCompensationInvoiced":{"type":"number","description":"Discount tax compensation invoiced amount."},"discountTaxCompensationRefunded":{"type":"number","description":"Discount tax compensation refunded amount."},"holdBeforeState":{"type":"string","description":"Hold before state."},"holdBeforeStatus":{"type":"string","description":"Hold before status."},"incrementId":{"type":"string","description":"Increment ID."},"isVirtual":{"type":"integer","description":"Is-virtual flag value."},"orderCurrencyCode":{"type":"string","description":"Order currency code."},"originalIncrementId":{"type":"string","description":"Original increment ID."},"paymentAuthorizationAmount":{"type":"number","description":"Payment authorization amount."},"paymentAuthExpiration":{"type":"integer","description":"Payment authorization expiration date."},"protectCode":{"type":"string","description":"Protect code."},"quoteAddressId":{"type":"integer","description":"Quote address ID."},"quoteId":{"type":"integer","description":"Quote ID."},"relationChildId":{"type":"string","description":"Relation child ID."},"relationChildRealId":{"type":"string","description":"Relation child real ID."},"relationParentId":{"type":"string","description":"Relation parent ID."},"relationParentRealId":{"type":"string","description":"Relation parent real ID."},"remoteIp":{"type":"string","description":"Remote IP address."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingCanceled":{"type":"number","description":"Shipping canceled amount."},"shippingDescription":{"type":"string","description":"Shipping description."},"shippingDiscountAmount":{"type":"number","description":"Shipping discount amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Shipping including tax amount."},"shippingInvoiced":{"type":"number","description":"Shipping invoiced amount."},"shippingRefunded":{"type":"number","description":"Shipping refunded amount."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount."},"shippingTaxRefunded":{"type":"number","description":"Shipping tax refunded amount."},"state":{"type":"string","description":"State."},"status":{"type":"string","description":"Status."},"storeCurrencyCode":{"type":"string","description":"Store currency code."},"storeId":{"type":"integer","description":"Store ID."},"storeName":{"type":"string","description":"Store name."},"storeToBaseRate":{"type":"number","description":"Store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Store-to-order rate."},"subtotal":{"type":"number","description":"Subtotal."},"subtotalCanceled":{"type":"number","description":"Subtotal canceled amount."},"subtotalInclTax":{"type":"number","description":"Subtotal including tax amount."},"subtotalInvoiced":{"type":"number","description":"Subtotal invoiced amount."},"subtotalRefunded":{"type":"number","description":"Subtotal refunded amount."},"taxAmount":{"type":"number","description":"Tax amount."},"taxCanceled":{"type":"number","description":"Tax canceled amount."},"taxInvoiced":{"type":"number","description":"Tax invoiced amount."},"taxRefunded":{"type":"number","description":"Tax refunded amount."},"totalCanceled":{"type":"number","description":"Total canceled."},"totalDue":{"type":"number","description":"Total due."},"totalInvoiced":{"type":"number","description":"Total invoiced amount."},"totalItemCount":{"type":"integer","description":"Total item count."},"totalOfflineRefunded":{"type":"number","description":"Total offline refunded amount."},"totalOnlineRefunded":{"type":"number","description":"Total online refunded amount."},"totalPaid":{"type":"number","description":"Total paid."},"totalQtyOrdered":{"type":"number","description":"Total quantity ordered."},"totalRefunded":{"type":"number","description":"Total amount refunded."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"xForwardedFor":{"type":"string","description":"X-Forwarded-For field value."},"items":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"billingAddress":{"$ref":"#/definitions/sales-data-order-address-interface"},"payment":{"$ref":"#/definitions/sales-data-order-payment-interface"},"statusHistories":{"type":"array","description":"Array of status histories.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-extension-interface"}},"required":["baseGrandTotal","customerEmail","grandTotal","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":{"additionalData":{"type":"string","description":"Additional data."},"amountRefunded":{"type":"number","description":"Amount refunded."},"appliedRuleIds":{"type":"string","description":"Applied rule IDs."},"baseAmountRefunded":{"type":"number","description":"Base amount refunded."},"baseCost":{"type":"number","description":"Base cost."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountInvoiced":{"type":"number","description":"Base discount invoiced."},"baseDiscountRefunded":{"type":"number","description":"Base discount refunded."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseDiscountTaxCompensationInvoiced":{"type":"number","description":"Base discount tax compensation invoiced."},"baseDiscountTaxCompensationRefunded":{"type":"number","description":"Base discount tax compensation refunded."},"baseOriginalPrice":{"type":"number","description":"Base original price."},"basePrice":{"type":"number","description":"Base price."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowInvoiced":{"type":"number","description":"Base row invoiced."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTaxBeforeDiscount":{"type":"number","description":"Base tax before discount."},"baseTaxInvoiced":{"type":"number","description":"Base tax invoiced."},"baseTaxRefunded":{"type":"number","description":"Base tax refunded."},"baseWeeeTaxAppliedAmount":{"type":"number","description":"Base WEEE tax applied amount."},"baseWeeeTaxAppliedRowAmnt":{"type":"number","description":"Base WEEE tax applied row amount."},"baseWeeeTaxDisposition":{"type":"number","description":"Base WEEE tax disposition."},"baseWeeeTaxRowDisposition":{"type":"number","description":"Base WEEE tax row disposition."},"createdAt":{"type":"string","description":"Created-at timestamp."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"discountInvoiced":{"type":"number","description":"Discount invoiced."},"discountPercent":{"type":"number","description":"Discount percent."},"discountRefunded":{"type":"number","description":"Discount refunded."},"eventId":{"type":"integer","description":"Event ID."},"extOrderItemId":{"type":"string","description":"External order item ID."},"freeShipping":{"type":"integer","description":"Free-shipping flag value."},"gwBasePrice":{"type":"number","description":"GW base price."},"gwBasePriceInvoiced":{"type":"number","description":"GW base price invoiced."},"gwBasePriceRefunded":{"type":"number","description":"GW base price refunded."},"gwBaseTaxAmount":{"type":"number","description":"GW base tax amount."},"gwBaseTaxAmountInvoiced":{"type":"number","description":"GW base tax amount invoiced."},"gwBaseTaxAmountRefunded":{"type":"number","description":"GW base tax amount refunded."},"gwId":{"type":"integer","description":"GW ID."},"gwPrice":{"type":"number","description":"GW price."},"gwPriceInvoiced":{"type":"number","description":"GW price invoiced."},"gwPriceRefunded":{"type":"number","description":"GW price refunded."},"gwTaxAmount":{"type":"number","description":"GW tax amount."},"gwTaxAmountInvoiced":{"type":"number","description":"GW tax amount invoiced."},"gwTaxAmountRefunded":{"type":"number","description":"GW tax amount refunded."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"discountTaxCompensationCanceled":{"type":"number","description":"Discount tax compensation canceled."},"discountTaxCompensationInvoiced":{"type":"number","description":"Discount tax compensation invoiced."},"discountTaxCompensationRefunded":{"type":"number","description":"Discount tax compensation refunded."},"isQtyDecimal":{"type":"integer","description":"Is-quantity-decimal flag value."},"isVirtual":{"type":"integer","description":"Is-virtual flag value."},"itemId":{"type":"integer","description":"Item ID."},"lockedDoInvoice":{"type":"integer","description":"Locked DO invoice flag value."},"lockedDoShip":{"type":"integer","description":"Locked DO ship flag value."},"name":{"type":"string","description":"Name."},"noDiscount":{"type":"integer","description":"No-discount flag value."},"orderId":{"type":"integer","description":"Order ID."},"originalPrice":{"type":"number","description":"Original price."},"parentItemId":{"type":"integer","description":"Parent item ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"productType":{"type":"string","description":"Product type."},"qtyBackordered":{"type":"number","description":"Quantity backordered."},"qtyCanceled":{"type":"number","description":"Quantity canceled."},"qtyInvoiced":{"type":"number","description":"Quantity invoiced."},"qtyOrdered":{"type":"number","description":"Quantity ordered."},"qtyRefunded":{"type":"number","description":"Quantity refunded."},"qtyReturned":{"type":"number","description":"Quantity returned."},"qtyShipped":{"type":"number","description":"Quantity shipped."},"quoteItemId":{"type":"integer","description":"Quote item ID."},"rowInvoiced":{"type":"number","description":"Row invoiced."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"rowWeight":{"type":"number","description":"Row weight."},"sku":{"type":"string","description":"SKU."},"storeId":{"type":"integer","description":"Store ID."},"taxAmount":{"type":"number","description":"Tax amount."},"taxBeforeDiscount":{"type":"number","description":"Tax before discount."},"taxCanceled":{"type":"number","description":"Tax canceled."},"taxInvoiced":{"type":"number","description":"Tax invoiced."},"taxPercent":{"type":"number","description":"Tax percent."},"taxRefunded":{"type":"number","description":"Tax refunded."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weeeTaxApplied":{"type":"string","description":"WEEE tax applied."},"weeeTaxAppliedAmount":{"type":"number","description":"WEEE tax applied amount."},"weeeTaxAppliedRowAmount":{"type":"number","description":"WEEE tax applied row amount."},"weeeTaxDisposition":{"type":"number","description":"WEEE tax disposition."},"weeeTaxRowDisposition":{"type":"number","description":"WEEE tax row disposition."},"weight":{"type":"number","description":"Weight."},"parentItem":{"$ref":"#/definitions/sales-data-order-item-interface"},"productOption":{"$ref":"#/definitions/catalog-data-product-option-interface"},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-item-extension-interface"}},"required":["sku"]},"catalog-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extensionAttributes":{"$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":{"customOptions":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"downloadableOption":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcardItemOption":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"},"configurableItemOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}},"bundleOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}}}},"sales-data-order-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderItemInterface","properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}}},"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":{"addressType":{"type":"string","description":"Address type."},"city":{"type":"string","description":"City."},"company":{"type":"string","description":"Company."},"countryId":{"type":"string","description":"Country ID."},"customerAddressId":{"type":"integer","description":"Country address ID."},"customerId":{"type":"integer","description":"Customer ID."},"email":{"type":"string","description":"Email address."},"entityId":{"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."},"parentId":{"type":"integer","description":"Parent ID."},"postcode":{"type":"string","description":"Postal code."},"prefix":{"type":"string","description":"Prefix."},"region":{"type":"string","description":"Region."},"regionCode":{"type":"string","description":"Region code."},"regionId":{"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."},"vatId":{"type":"string","description":"VAT ID."},"vatIsValid":{"type":"integer","description":"VAT-is-valid flag value."},"vatRequestDate":{"type":"string","description":"VAT request date."},"vatRequestId":{"type":"string","description":"VAT request ID."},"vatRequestSuccess":{"type":"integer","description":"VAT-request-success flag value."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-address-extension-interface"}},"required":["addressType","city","countryId","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":{"accountStatus":{"type":"string","description":"Account status."},"additionalData":{"type":"string","description":"Additional data."},"additionalInformation":{"type":"array","description":"Array of additional information.","items":{"type":"string"}},"addressStatus":{"type":"string","description":"Address status."},"amountAuthorized":{"type":"number","description":"Amount authorized."},"amountCanceled":{"type":"number","description":"Amount canceled."},"amountOrdered":{"type":"number","description":"Amount ordered."},"amountPaid":{"type":"number","description":"Amount paid."},"amountRefunded":{"type":"number","description":"Amount refunded."},"anetTransMethod":{"type":"string","description":"Anet transaction method."},"baseAmountAuthorized":{"type":"number","description":"Base amount authorized."},"baseAmountCanceled":{"type":"number","description":"Base amount canceled."},"baseAmountOrdered":{"type":"number","description":"Base amount ordered."},"baseAmountPaid":{"type":"number","description":"Base amount paid."},"baseAmountPaidOnline":{"type":"number","description":"Base amount paid online."},"baseAmountRefunded":{"type":"number","description":"Base amount refunded."},"baseAmountRefundedOnline":{"type":"number","description":"Base amount refunded online."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingCaptured":{"type":"number","description":"Base shipping captured amount."},"baseShippingRefunded":{"type":"number","description":"Base shipping refunded amount."},"ccApproval":{"type":"string","description":"Credit card approval."},"ccAvsStatus":{"type":"string","description":"Credit card avs status."},"ccCidStatus":{"type":"string","description":"Credit card CID status."},"ccDebugRequestBody":{"type":"string","description":"Credit card debug request body."},"ccDebugResponseBody":{"type":"string","description":"Credit card debug response body."},"ccDebugResponseSerialized":{"type":"string","description":"Credit card debug response serialized."},"ccExpMonth":{"type":"string","description":"Credit card expiration month."},"ccExpYear":{"type":"string","description":"Credit card expiration year."},"ccLast4":{"type":"string","description":"Last four digits of the credit card."},"ccNumberEnc":{"type":"string","description":"Encrypted credit card number."},"ccOwner":{"type":"string","description":"Credit card number."},"ccSecureVerify":{"type":"string","description":"Credit card secure verify."},"ccSsIssue":{"type":"string","description":"Credit card SS issue."},"ccSsStartMonth":{"type":"string","description":"Credit card SS start month."},"ccSsStartYear":{"type":"string","description":"Credit card SS start year."},"ccStatus":{"type":"string","description":"Credit card status."},"ccStatusDescription":{"type":"string","description":"Credit card status description."},"ccTransId":{"type":"string","description":"Credit card transaction ID."},"ccType":{"type":"string","description":"Credit card type."},"echeckAccountName":{"type":"string","description":"eCheck account name."},"echeckAccountType":{"type":"string","description":"eCheck account type."},"echeckBankName":{"type":"string","description":"eCheck bank name."},"echeckRoutingNumber":{"type":"string","description":"eCheck routing number."},"echeckType":{"type":"string","description":"eCheck type."},"entityId":{"type":"integer","description":"Entity ID."},"lastTransId":{"type":"string","description":"Last transaction ID."},"method":{"type":"string","description":"Method."},"parentId":{"type":"integer","description":"Parent ID."},"poNumber":{"type":"string","description":"PO number."},"protectionEligibility":{"type":"string","description":"Protection eligibility."},"quotePaymentId":{"type":"integer","description":"Quote payment ID."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingCaptured":{"type":"number","description":"Shipping captured."},"shippingRefunded":{"type":"number","description":"Shipping refunded."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-payment-extension-interface"}},"required":["accountStatus","additionalInformation","ccLast4","method"]},"sales-data-order-payment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderPaymentInterface"},"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."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Order status history ID."},"entityName":{"type":"string","description":"Entity name."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"status":{"type":"string","description":"Status."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-status-history-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"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":{"shippingAssignments":{"type":"array","items":{"$ref":"#/definitions/sales-data-shipping-assignment-interface"}},"appliedTaxes":{"type":"array","items":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-interface"}},"itemAppliedTaxes":{"type":"array","items":{"$ref":"#/definitions/tax-data-order-tax-details-item-interface"}},"convertingFromQuote":{"type":"boolean"},"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"},"gwId":{"type":"string"},"gwAllowGiftReceipt":{"type":"string"},"gwAddCard":{"type":"string"},"gwPrice":{"type":"string"},"gwBasePrice":{"type":"string"},"gwItemsPrice":{"type":"string"},"gwItemsBasePrice":{"type":"string"},"gwCardPrice":{"type":"string"},"gwCardBasePrice":{"type":"string"},"gwBaseTaxAmount":{"type":"string"},"gwTaxAmount":{"type":"string"},"gwItemsBaseTaxAmount":{"type":"string"},"gwItemsTaxAmount":{"type":"string"},"gwCardBaseTaxAmount":{"type":"string"},"gwCardTaxAmount":{"type":"string"},"gwPriceInclTax":{"type":"string"},"gwBasePriceInclTax":{"type":"string"},"gwCardPriceInclTax":{"type":"string"},"gwCardBasePriceInclTax":{"type":"string"},"gwItemsPriceInclTax":{"type":"string"},"gwItemsBasePriceInclTax":{"type":"string"}}},"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"}},"stockId":{"type":"integer","description":"Stock id"},"extensionAttributes":{"$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"},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipping-extension-interface"}}},"sales-data-total-interface":{"type":"object","description":"Interface TotalInterface","properties":{"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingCanceled":{"type":"number","description":"Base shipping canceled."},"baseShippingDiscountAmount":{"type":"number","description":"Base shipping discount amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Base shipping including tax."},"baseShippingInvoiced":{"type":"number","description":"Base shipping invoiced."},"baseShippingRefunded":{"type":"number","description":"Base shipping refunded."},"baseShippingTaxAmount":{"type":"number","description":"Base shipping tax amount."},"baseShippingTaxRefunded":{"type":"number","description":"Base shipping tax refunded."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingCanceled":{"type":"number","description":"Shipping canceled amount."},"shippingDiscountAmount":{"type":"number","description":"Shipping discount amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Shipping including tax amount."},"shippingInvoiced":{"type":"number","description":"Shipping invoiced amount."},"shippingRefunded":{"type":"number","description":"Shipping refunded amount."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount."},"shippingTaxRefunded":{"type":"number","description":"Shipping tax refunded amount."},"extensionAttributes":{"$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"},"tax-data-order-tax-details-applied-tax-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Title"},"percent":{"type":"number","description":"Tax Percent"},"amount":{"type":"number","description":"Tax amount"},"baseAmount":{"type":"number","description":"Tax amount in base currency"},"extensionAttributes":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-extension-interface"}},"required":["amount","baseAmount"]},"tax-data-order-tax-details-applied-tax-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\OrderTaxDetailsAppliedTaxInterface"},"tax-data-order-tax-details-item-interface":{"type":"object","description":"","properties":{"type":{"type":"string","description":"Type (shipping, product, weee, gift wrapping, etc)"},"itemId":{"type":"integer","description":"Item id if this item is a product"},"associatedItemId":{"type":"integer","description":"Associated item id if this item is associated with another item, null otherwise"},"appliedTaxes":{"type":"array","description":"Applied taxes","items":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-interface"}},"extensionAttributes":{"$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"},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-invoice-interface":{"type":"object","description":"Invoice interface. An invoice is a record of the receipt of payment for an order.","properties":{"baseCurrencyCode":{"type":"string","description":"Base currency code."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseGrandTotal":{"type":"number","description":"Base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Base shipping including tax."},"baseShippingTaxAmount":{"type":"number","description":"Base shipping tax amount."},"baseSubtotal":{"type":"number","description":"Base subtotal."},"baseSubtotalInclTax":{"type":"number","description":"Base subtotal including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTotalRefunded":{"type":"number","description":"Base total refunded."},"baseToGlobalRate":{"type":"number","description":"Base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Base-to-order rate."},"billingAddressId":{"type":"integer","description":"Billing address ID."},"canVoidFlag":{"type":"integer","description":"Can void flag value."},"createdAt":{"type":"string","description":"Created-at timestamp."},"discountAmount":{"type":"number","description":"Discount amount."},"discountDescription":{"type":"string","description":"Discount description."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Invoice ID."},"globalCurrencyCode":{"type":"string","description":"Global currency code."},"grandTotal":{"type":"number","description":"Grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"incrementId":{"type":"string","description":"Increment ID."},"isUsedForRefund":{"type":"integer","description":"Is-used-for-refund flag value."},"orderCurrencyCode":{"type":"string","description":"Order currency code."},"orderId":{"type":"integer","description":"Order ID."},"shippingAddressId":{"type":"integer","description":"Shipping address ID."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Shipping including tax."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount."},"state":{"type":"integer","description":"State."},"storeCurrencyCode":{"type":"string","description":"Store currency code."},"storeId":{"type":"integer","description":"Store ID."},"storeToBaseRate":{"type":"number","description":"Store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Store-to-order rate."},"subtotal":{"type":"number","description":"Subtotal."},"subtotalInclTax":{"type":"number","description":"Subtotal including tax."},"taxAmount":{"type":"number","description":"Tax amount."},"totalQty":{"type":"number","description":"Total quantity."},"transactionId":{"type":"string","description":"Transaction ID."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-extension-interface"}},"required":["orderId","totalQty","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":{"additionalData":{"type":"string","description":"Additional data."},"baseCost":{"type":"number","description":"Base cost."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"basePrice":{"type":"number","description":"Base price."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"entityId":{"type":"integer","description":"Invoice item ID."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"name":{"type":"string","description":"Name."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"sku":{"type":"string","description":"SKU."},"taxAmount":{"type":"number","description":"Tax amount."},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-item-extension-interface"},"orderItemId":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["sku","orderItemId","qty"]},"sales-data-invoice-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceItemInterface"},"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":{"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-comment-extension-interface"},"comment":{"type":"string","description":"Comment."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Invoice ID."}},"required":["isCustomerNotified","parentId","comment","isVisibleOnFront"]},"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"},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-creditmemo-item-creation-interface":{"type":"object","description":"Interface CreditmemoItemCreationInterface","properties":{"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-item-creation-extension-interface"},"orderItemId":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["orderItemId","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":{"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-comment-creation-extension-interface"},"comment":{"type":"string","description":"Comment."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."}},"required":["comment","isVisibleOnFront"]},"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":{"shippingAmount":{"type":"number","description":"Credit memo shipping amount."},"adjustmentPositive":{"type":"number","description":"Credit memo positive adjustment."},"adjustmentNegative":{"type":"number","description":"Credit memo negative adjustment."},"extensionAttributes":{"$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":{"returnToStockItems":{"type":"array","items":{"type":"integer"}}}},"sales-data-creditmemo-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Credit memo ID."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-comment-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"sales-data-creditmemo-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoCommentInterface"},"sales-data-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"adjustmentNegative":{"type":"number","description":"Credit memo negative adjustment."},"adjustmentPositive":{"type":"number","description":"Credit memo positive adjustment."},"baseAdjustment":{"type":"number","description":"Credit memo base adjustment."},"baseAdjustmentNegative":{"type":"number","description":"Credit memo negative base adjustment."},"baseAdjustmentPositive":{"type":"number","description":"Credit memo positive base adjustment."},"baseCurrencyCode":{"type":"string","description":"Credit memo base currency code."},"baseDiscountAmount":{"type":"number","description":"Credit memo base discount amount."},"baseGrandTotal":{"type":"number","description":"Credit memo base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Credit memo base discount tax compensation amount."},"baseShippingAmount":{"type":"number","description":"Credit memo base shipping amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Credit memo base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Credit memo base shipping including tax."},"baseShippingTaxAmount":{"type":"number","description":"Credit memo base shipping tax amount."},"baseSubtotal":{"type":"number","description":"Credit memo base subtotal."},"baseSubtotalInclTax":{"type":"number","description":"Credit memo base subtotal including tax."},"baseTaxAmount":{"type":"number","description":"Credit memo base tax amount."},"baseToGlobalRate":{"type":"number","description":"Credit memo base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Credit memo base-to-order rate."},"billingAddressId":{"type":"integer","description":"Credit memo billing address ID."},"createdAt":{"type":"string","description":"Credit memo created-at timestamp."},"creditmemoStatus":{"type":"integer","description":"Credit memo status."},"discountAmount":{"type":"number","description":"Credit memo discount amount."},"discountDescription":{"type":"string","description":"Credit memo discount description."},"emailSent":{"type":"integer","description":"Credit memo email sent flag value."},"entityId":{"type":"integer","description":"Credit memo ID."},"globalCurrencyCode":{"type":"string","description":"Credit memo global currency code."},"grandTotal":{"type":"number","description":"Credit memo grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Credit memo discount tax compensation amount."},"incrementId":{"type":"string","description":"Credit memo increment ID."},"invoiceId":{"type":"integer","description":"Credit memo invoice ID."},"orderCurrencyCode":{"type":"string","description":"Credit memo order currency code."},"orderId":{"type":"integer","description":"Credit memo order ID."},"shippingAddressId":{"type":"integer","description":"Credit memo shipping address ID."},"shippingAmount":{"type":"number","description":"Credit memo shipping amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Credit memo shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Credit memo shipping including tax."},"shippingTaxAmount":{"type":"number","description":"Credit memo shipping tax amount."},"state":{"type":"integer","description":"Credit memo state."},"storeCurrencyCode":{"type":"string","description":"Credit memo store currency code."},"storeId":{"type":"integer","description":"Credit memo store ID."},"storeToBaseRate":{"type":"number","description":"Credit memo store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Credit memo store-to-order rate."},"subtotal":{"type":"number","description":"Credit memo subtotal."},"subtotalInclTax":{"type":"number","description":"Credit memo subtotal including tax."},"taxAmount":{"type":"number","description":"Credit memo tax amount."},"transactionId":{"type":"string","description":"Credit memo transaction ID."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-extension-interface"}},"required":["orderId","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":{"additionalData":{"type":"string","description":"Additional data."},"baseCost":{"type":"number","description":"The base cost for a credit memo item."},"baseDiscountAmount":{"type":"number","description":"The base discount amount for a credit memo item."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"The base discount tax compensation amount for a credit memo item."},"basePrice":{"type":"number","description":"The base price for a credit memo item."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseWeeeTaxAppliedAmount":{"type":"number","description":"Base WEEE tax applied amount."},"baseWeeeTaxAppliedRowAmnt":{"type":"number","description":"Base WEEE tax applied row amount."},"baseWeeeTaxDisposition":{"type":"number","description":"Base WEEE tax disposition."},"baseWeeeTaxRowDisposition":{"type":"number","description":"Base WEEE tax row disposition."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"entityId":{"type":"integer","description":"Credit memo item ID."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"name":{"type":"string","description":"Name."},"orderItemId":{"type":"integer","description":"Order item ID."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"qty":{"type":"number","description":"Quantity."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"sku":{"type":"string","description":"SKU."},"taxAmount":{"type":"number","description":"Tax amount."},"weeeTaxApplied":{"type":"string","description":"WEEE tax applied."},"weeeTaxAppliedAmount":{"type":"number","description":"WEEE tax applied amount."},"weeeTaxAppliedRowAmount":{"type":"number","description":"WEEE tax applied row amount."},"weeeTaxDisposition":{"type":"number","description":"WEEE tax disposition."},"weeeTaxRowDisposition":{"type":"number","description":"WEEE tax row disposition."},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-item-extension-interface"}},"required":["baseCost","basePrice","entityId","orderItemId","qty"]},"sales-data-creditmemo-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoItemInterface"},"sales-data-creditmemo-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoInterface"},"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":{"billingAddressId":{"type":"integer","description":"Billing address ID."},"createdAt":{"type":"string","description":"Created-at timestamp."},"customerId":{"type":"integer","description":"Customer ID."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Shipment ID."},"incrementId":{"type":"string","description":"Increment ID."},"orderId":{"type":"integer","description":"Order ID."},"packages":{"type":"array","description":"Array of packages, if any. Otherwise, null.","items":{"$ref":"#/definitions/sales-data-shipment-package-interface"}},"shipmentStatus":{"type":"integer","description":"Shipment status."},"shippingAddressId":{"type":"integer","description":"Shipping address ID."},"shippingLabel":{"type":"string","description":"Shipping label."},"storeId":{"type":"integer","description":"Store ID."},"totalQty":{"type":"number","description":"Total quantity."},"totalWeight":{"type":"number","description":"Total weight."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-extension-interface"}},"required":["orderId","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":{"extensionAttributes":{"$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":{"additionalData":{"type":"string","description":"Additional data."},"description":{"type":"string","description":"Description."},"entityId":{"type":"integer","description":"Shipment item ID."},"name":{"type":"string","description":"Name."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"productId":{"type":"integer","description":"Product ID."},"rowTotal":{"type":"number","description":"Row total."},"sku":{"type":"string","description":"SKU."},"weight":{"type":"number","description":"Weight."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-item-extension-interface"},"orderItemId":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["orderItemId","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":{"orderId":{"type":"integer","description":"The order_id for the shipment package."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Shipment package ID."},"parentId":{"type":"integer","description":"Parent ID."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"qty":{"type":"number","description":"Quantity."},"description":{"type":"string","description":"Description."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-track-extension-interface"},"trackNumber":{"type":"string","description":"Track number."},"title":{"type":"string","description":"Title."},"carrierCode":{"type":"string","description":"Carrier code."}},"required":["orderId","parentId","weight","qty","description","trackNumber","title","carrierCode"]},"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":{"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-comment-extension-interface"},"comment":{"type":"string","description":"Comment."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Invoice ID."}},"required":["isCustomerNotified","parentId","comment","isVisibleOnFront"]},"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"},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-shipment-item-creation-interface":{"type":"object","description":"Input argument for shipment item creation Interface ShipmentItemCreationInterface","properties":{"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-item-creation-extension-interface"},"orderItemId":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["orderItemId","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":{"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-comment-creation-extension-interface"},"comment":{"type":"string","description":"Comment."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."}},"required":["comment","isVisibleOnFront"]},"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":{"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-track-creation-extension-interface"},"trackNumber":{"type":"string","description":"Track number."},"title":{"type":"string","description":"Title."},"carrierCode":{"type":"string","description":"Carrier code."}},"required":["trackNumber","title","carrierCode"]},"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":{"extensionAttributes":{"$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":{"extensionAttributes":{"$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"},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transactionId":{"type":"integer","description":"Transaction ID."},"parentId":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"orderId":{"type":"integer","description":"Order ID."},"paymentId":{"type":"integer","description":"Payment ID."},"txnId":{"type":"string","description":"Transaction business ID."},"parentTxnId":{"type":"string","description":"Parent transaction business ID."},"txnType":{"type":"string","description":"Transaction type."},"isClosed":{"type":"integer","description":"Is-closed flag value."},"additionalInformation":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"createdAt":{"type":"string","description":"Created-at timestamp."},"childTransactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transactionId","orderId","paymentId","txnId","parentTxnId","txnType","isClosed","createdAt","childTransactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-invoice-item-creation-interface":{"type":"object","description":"Input argument for invoice creation Interface InvoiceItemCreationInterface","properties":{"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-item-creation-extension-interface"},"orderItemId":{"type":"integer","description":"Order item ID."},"qty":{"type":"number","description":"Quantity."}},"required":["orderItemId","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":{"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-comment-creation-extension-interface"},"comment":{"type":"string","description":"Comment."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."}},"required":["comment","isVisibleOnFront"]},"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":{"extensionAttributes":{"$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"},"catalog-inventory-data-stock-status-collection-interface":{"type":"object","description":"Stock Status collection interface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"searchCriteria":{"$ref":"#/definitions/catalog-inventory-stock-status-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"productId":{"type":"integer"},"stockId":{"type":"integer"},"qty":{"type":"integer"},"stockStatus":{"type":"integer"},"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extensionAttributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["productId","stockId","qty","stockStatus","stockItem"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"catalog-inventory-stock-status-criteria-interface":{"type":"object","description":"Interface StockStatusCriteriaInterface","properties":{"mapperInterfaceName":{"type":"string","description":"Associated Mapper Interface name"},"criteriaList":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapperInterfaceName","criteriaList","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapperInterfaceName":{"type":"string","description":"Associated Mapper Interface name"},"criteriaList":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapperInterfaceName","criteriaList","filters","orders","limit"]},"checkout-agreements-data-agreement-interface":{"type":"object","description":"","properties":{"agreementId":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"contentHeight":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkboxText":{"type":"string","description":"Agreement checkbox text."},"isActive":{"type":"boolean","description":"Agreement status."},"isHtml":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extensionAttributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreementId","name","content","checkboxText","isActive","isHtml","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"checkout-data-shipping-information-interface":{"type":"object","description":"","properties":{"shippingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"shippingMethodCode":{"type":"string","description":"Shipping method code"},"shippingCarrierCode":{"type":"string","description":"Carrier code"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-shipping-information-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["shippingAddress","shippingMethodCode","shippingCarrierCode"]},"checkout-data-shipping-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\ShippingInformationInterface"},"checkout-data-payment-details-interface":{"type":"object","description":"","properties":{"paymentMethods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["paymentMethods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"checkout-data-totals-information-interface":{"type":"object","description":"","properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"shippingMethodCode":{"type":"string","description":"Shipping method code"},"shippingCarrierCode":{"type":"string","description":"Carrier code"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-totals-information-extension-interface"},"customAttributes":{"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"},"tax-data-tax-rate-interface":{"type":"object","description":"Tax rate interface.","properties":{"id":{"type":"integer","description":"Id"},"taxCountryId":{"type":"string","description":"Country id"},"taxRegionId":{"type":"integer","description":"Region id"},"regionName":{"type":"string","description":"Region name"},"taxPostcode":{"type":"string","description":"Postcode"},"zipIsRange":{"type":"integer","description":"Zip is range"},"zipFrom":{"type":"integer","description":"Zip range from"},"zipTo":{"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"}},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rate-extension-interface"}},"required":["taxCountryId","rate","code"]},"tax-data-tax-rate-title-interface":{"type":"object","description":"Tax rate title interface.","properties":{"storeId":{"type":"string","description":"Store id"},"value":{"type":"string","description":"Title value"},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rate-title-extension-interface"}},"required":["storeId","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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"customerTaxClassIds":{"type":"array","description":"Customer tax class id","items":{"type":"integer"}},"productTaxClassIds":{"type":"array","description":"Product tax class id","items":{"type":"integer"}},"taxRateIds":{"type":"array","description":"Tax rate ids","items":{"type":"integer"}},"calculateSubtotal":{"type":"boolean","description":"Calculate subtotal."},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rule-extension-interface"}},"required":["code","priority","position","customerTaxClassIds","productTaxClassIds","taxRateIds"]},"tax-data-tax-rule-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxRuleInterface"},"tax-data-tax-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"tax-data-tax-class-interface":{"type":"object","description":"Tax class interface.","properties":{"classId":{"type":"integer","description":"Tax class ID."},"className":{"type":"string","description":"Tax class name."},"classType":{"type":"string","description":"Tax class type."},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-class-extension-interface"}},"required":["className","classType"]},"tax-data-tax-class-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxClassInterface"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-rule-data-rule-interface":{"type":"object","description":"Interface RuleInterface","properties":{"ruleId":{"type":"integer","description":"Rule id"},"name":{"type":"string","description":"Rule name"},"storeLabels":{"type":"array","description":"Display label","items":{"$ref":"#/definitions/sales-rule-data-rule-label-interface"}},"description":{"type":"string","description":"Description"},"websiteIds":{"type":"array","description":"A list of websites the rule applies to","items":{"type":"integer"}},"customerGroupIds":{"type":"array","description":"Ids of customer groups that the rule applies to","items":{"type":"integer"}},"fromDate":{"type":"string","description":"The start date when the coupon is active"},"toDate":{"type":"string","description":"The end date when the coupon is active"},"usesPerCustomer":{"type":"integer","description":"Number of uses per customer"},"isActive":{"type":"boolean","description":"The coupon is active"},"condition":{"$ref":"#/definitions/sales-rule-data-condition-interface"},"actionCondition":{"$ref":"#/definitions/sales-rule-data-condition-interface"},"stopRulesProcessing":{"type":"boolean","description":"To stop rule processing"},"isAdvanced":{"type":"boolean","description":"Is this field needed"},"productIds":{"type":"array","description":"Product ids","items":{"type":"integer"}},"sortOrder":{"type":"integer","description":"Sort order"},"simpleAction":{"type":"string","description":"Simple action of the rule"},"discountAmount":{"type":"number","description":"Discount amount"},"discountQty":{"type":"number","description":"Maximum qty discount is applied"},"discountStep":{"type":"integer","description":"Discount step"},"applyToShipping":{"type":"boolean","description":"The rule applies to shipping"},"timesUsed":{"type":"integer","description":"How many times the rule has been used"},"isRss":{"type":"boolean","description":"Whether the rule is in RSS"},"couponType":{"type":"string","description":"Coupon type"},"useAutoGeneration":{"type":"boolean","description":"To auto generate coupon"},"usesPerCoupon":{"type":"integer","description":"Limit of uses per coupon"},"simpleFreeShipping":{"type":"string","description":"To grant free shipping"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-rule-extension-interface"}},"required":["websiteIds","customerGroupIds","usesPerCustomer","isActive","stopRulesProcessing","isAdvanced","sortOrder","discountAmount","discountStep","applyToShipping","timesUsed","isRss","couponType","useAutoGeneration","usesPerCoupon"]},"sales-rule-data-rule-label-interface":{"type":"object","description":"Interface RuleLabelInterface","properties":{"storeId":{"type":"integer","description":"StoreId"},"storeLabel":{"type":"string","description":"The label for the store"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-rule-label-extension-interface"}},"required":["storeId","storeLabel"]},"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":{"conditionType":{"type":"string","description":"Condition type"},"conditions":{"type":"array","description":"List of conditions","items":{"$ref":"#/definitions/sales-rule-data-condition-interface"}},"aggregatorType":{"type":"string","description":"The aggregator type"},"operator":{"type":"string","description":"The operator of the condition"},"attributeName":{"type":"string","description":"The attribute name of the condition"},"value":{"type":"string","description":"The value of the condition"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-condition-extension-interface"}},"required":["conditionType","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":{"rewardPointsDelta":{"type":"integer"}}},"sales-rule-data-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-rule-data-coupon-interface":{"type":"object","description":"Interface CouponInterface","properties":{"couponId":{"type":"integer","description":"Coupon id"},"ruleId":{"type":"integer","description":"The id of the rule associated with the coupon"},"code":{"type":"string","description":"Coupon code"},"usageLimit":{"type":"integer","description":"Usage limit"},"usagePerCustomer":{"type":"integer","description":"Usage limit per customer"},"timesUsed":{"type":"integer","description":"The number of times the coupon has been used"},"expirationDate":{"type":"string","description":"Expiration date"},"isPrimary":{"type":"boolean","description":"The coupon is primary coupon for the rule that it's associated with"},"createdAt":{"type":"string","description":"When the coupon is created"},"type":{"type":"integer","description":"Of coupon"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-coupon-extension-interface"}},"required":["ruleId","timesUsed","isPrimary"]},"sales-rule-data-coupon-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\CouponInterface"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-rule-data-coupon-generation-spec-interface":{"type":"object","description":"CouponGenerationSpecInterface","properties":{"ruleId":{"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"},"delimiterAtEvery":{"type":"integer","description":"The spacing where the delimiter should exist"},"delimiter":{"type":"string","description":"The delimiter"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-extension-interface"}},"required":["ruleId","format","quantity","length"]},"sales-rule-data-coupon-generation-spec-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\CouponGenerationSpecInterface"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failedItems":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missingItems":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failedItems","missingItems"]},"gift-card-account-data-gift-card-account-interface":{"type":"object","description":"Gift Card Account data","properties":{"giftCards":{"type":"array","description":"Cards codes","items":{"type":"string"}},"giftCardsAmount":{"type":"number","description":"Cards amount in quote currency"},"baseGiftCardsAmount":{"type":"number","description":"Cards amount in base currency"},"giftCardsAmountUsed":{"type":"number","description":"Cards amount used in quote currency"},"baseGiftCardsAmountUsed":{"type":"number","description":"Cards amount used in base currency"},"extensionAttributes":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-extension-interface"}},"required":["giftCards","giftCardsAmount","baseGiftCardsAmount","giftCardsAmountUsed","baseGiftCardsAmountUsed"]},"gift-card-account-data-gift-card-account-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftCardAccount\\Api\\Data\\GiftCardAccountInterface"},"gift-wrapping-data-wrapping-interface":{"type":"object","description":"","properties":{"wrappingId":{"type":"integer"},"design":{"type":"string"},"status":{"type":"integer"},"basePrice":{"type":"number"},"imageName":{"type":"string"},"imageBase64Content":{"type":"string"},"baseCurrencyCode":{"type":"string"},"websiteIds":{"type":"array","items":{"type":"integer"}},"imageUrl":{"type":"string","description":"Wrapping image URL."},"extensionAttributes":{"$ref":"#/definitions/gift-wrapping-data-wrapping-extension-interface"}},"required":["design","status","basePrice"]},"gift-wrapping-data-wrapping-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\GiftWrapping\\Api\\Data\\WrappingInterface"},"gift-wrapping-data-wrapping-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extensionAttributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"rma-data-track-interface":{"type":"object","description":"Interface TrackInterface","properties":{"entityId":{"type":"integer","description":"Entity id"},"rmaEntityId":{"type":"integer","description":"Rma entity id"},"trackNumber":{"type":"string","description":"Track number"},"carrierTitle":{"type":"string","description":"Carrier title"},"carrierCode":{"type":"string","description":"Carrier code"},"extensionAttributes":{"$ref":"#/definitions/rma-data-track-extension-interface"}},"required":["entityId","rmaEntityId","trackNumber","carrierTitle","carrierCode"]},"rma-data-track-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Rma\\Api\\Data\\TrackInterface"},"rma-data-track-search-result-interface":{"type":"object","description":"Interface TrackSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-track-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"rma-data-rma-interface":{"type":"object","description":"Interface RmaInterface","properties":{"incrementId":{"type":"string","description":"Entity_id"},"entityId":{"type":"integer","description":"Entity_id"},"orderId":{"type":"integer","description":"Order_id"},"orderIncrementId":{"type":"string","description":"Order_increment_id"},"storeId":{"type":"integer","description":"Store_id"},"customerId":{"type":"integer","description":"Customer_id"},"dateRequested":{"type":"string","description":"Date_requested"},"customerCustomEmail":{"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"}},"extensionAttributes":{"$ref":"#/definitions/rma-data-rma-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["incrementId","entityId","orderId","orderIncrementId","storeId","customerId","dateRequested","customerCustomEmail","items","status","comments","tracks"]},"rma-data-item-interface":{"type":"object","description":"Interface CategoryInterface","properties":{"entityId":{"type":"integer","description":"Id"},"rmaEntityId":{"type":"integer","description":"RMA id"},"orderItemId":{"type":"integer","description":"Order_item_id"},"qtyRequested":{"type":"integer","description":"Qty_requested"},"qtyAuthorized":{"type":"integer","description":"Qty_authorized"},"qtyApproved":{"type":"integer","description":"Qty_approved"},"qtyReturned":{"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"},"extensionAttributes":{"$ref":"#/definitions/rma-data-item-extension-interface"}},"required":["entityId","rmaEntityId","orderItemId","qtyRequested","qtyAuthorized","qtyApproved","qtyReturned","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"},"rmaEntityId":{"type":"integer","description":"Rma Id"},"createdAt":{"type":"string","description":"Created_at"},"entityId":{"type":"integer","description":"Entity_id"},"customerNotified":{"type":"boolean","description":"Is_customer_notified"},"visibleOnFront":{"type":"boolean","description":"Is_visible_on_front"},"status":{"type":"string","description":"Status"},"admin":{"type":"boolean","description":"Is_admin"},"extensionAttributes":{"$ref":"#/definitions/rma-data-comment-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["comment","rmaEntityId","createdAt","entityId","customerNotified","visibleOnFront","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"},"rma-data-comment-search-result-interface":{"type":"object","description":"Interface CommentSearchResultInterface","properties":{"items":{"type":"array","description":"Rma Status History list","items":{"$ref":"#/definitions/rma-data-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"rma-data-rma-search-result-interface":{"type":"object","description":"Interface RmaSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-rma-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"framework-metadata-object-interface":{"type":"object","description":"Provides metadata about an attribute.","properties":{"attributeCode":{"type":"string","description":"Code of the attribute."}},"required":["attributeCode"]}}} diff --git a/src/swagger/schemas/latest-2.1.schema.json b/src/swagger/schemas/latest-2.1.schema.json deleted file mode 100644 index b71bc670b1c..00000000000 --- a/src/swagger/schemas/latest-2.1.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.1","title":"Magento Enterprise Edition 2.1"},"host":"t213.vg","basePath":"/rest/default","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":"Interface ProductWebsiteLinkRepositoryInterface"},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"searchV1","description":"Search API for all requests"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteGuestShipmentEstimationV1","description":"Interface GuestShipmentEstimationInterface"},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesRefundInvoiceV1","description":"Interface RefundInvoiceInterface"},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesRefundOrderV1","description":"Interface RefundOrderInterface"},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesShipOrderV1","description":"Class ShipOrderInterface"},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"salesInvoiceOrderV1","description":"Class InvoiceOrderInterface"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"customerBalanceBalanceManagementV1","description":"Customer balance(store credit) operations"},{"name":"giftCardAccountGiftCardAccountManagementV1","description":"Interface GiftCardAccountManagementInterface"},{"name":"giftCardAccountGuestGiftCardAccountManagementV1","description":"Interface GuestGiftCardAccountManagementInterface"},{"name":"giftRegistryShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"giftRegistryGuestCartShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"},{"name":"giftWrappingWrappingRepositoryV1","description":"Interface WrappingRepositoryInterface"},{"name":"rewardRewardManagementV1","description":"Interface RewardManagementInterface"},{"name":"rmaTrackManagementV1","description":"Interface TrackManagementInterface"},{"name":"rmaRmaRepositoryV1","description":"Interface RmaRepositoryInterface"},{"name":"rmaCommentManagementV1","description":"Interface CommentRepositoryInterface"},{"name":"rmaRmaManagementV1","description":"Interface RmaManagementInterface"},{"name":"rmaRmaAttributesManagementV1","description":"Interface RmaAttributesManagementInterface"},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"},{"name":"worldpayGuestPaymentInformationManagementProxyV1","description":"Interface GuestPaymentInformationManagementProxyInterface"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{id}":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","parameters":[{"name":"$body","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"put":{"tags":["quoteCartRepositoryV1"],"description":"Save quote","operationId":"quoteCartRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/items":{"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/create":{"put":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/":{"post":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"$body","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoice/{invoiceId}/refund":{"post":{"tags":["salesRefundInvoiceV1"],"description":"Create refund for invoice","operationId":"salesRefundInvoiceV1ExecutePost","parameters":[{"name":"invoiceId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/refund":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Prepare creditmemo to refund and save it.","operationId":"salesCreditmemoManagementV1RefundPost","parameters":[{"name":"$body","in":"body","schema":{"required":["creditmemo"],"properties":{"creditmemo":{"$ref":"#/definitions/sales-data-creditmemo-interface"},"offlineRequested":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/refund":{"post":{"tags":["salesRefundOrderV1"],"description":"Create offline refund for order","operationId":"salesRefundOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/ship":{"post":{"tags":["salesShipOrderV1"],"description":"Creates new Shipment for given Order.","operationId":"salesShipOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Id of created Shipment."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/invoice":{"post":{"tags":["salesInvoiceOrderV1"],"description":"","operationId":"salesInvoiceOrderV1ExecutePost","parameters":[{"name":"orderId","in":"path","type":"integer","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"$body","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"$body","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"$body","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Configurable product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/balance/apply":{"post":{"tags":["customerBalanceBalanceManagementV1"],"description":"Apply store credit","operationId":"customerBalanceBalanceManagementV1ApplyPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/giftCards":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Return GiftCard Account cards","operationId":"giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards":{"put":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards":{"post":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards":{"post":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/giftregistry/mine/estimate-shipping-methods":{"post":{"tags":["giftRegistryShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":{"post":{"tags":["giftRegistryGuestCartShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{id}":{"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return data object for specified wrapping ID and store.","operationId":"giftWrappingWrappingRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Delete gift wrapping","operationId":"giftWrappingWrappingRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings":{"post":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return list of gift wrapping data objects based on search criteria","operationId":"giftWrappingWrappingRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{wrappingId}":{"put":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePut","parameters":[{"name":"wrappingId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/reward/mine/use-reward":{"post":{"tags":["rewardRewardManagementV1"],"description":"Set reward points to quote","operationId":"rewardRewardManagementV1SetPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers":{"post":{"tags":["rmaTrackManagementV1"],"description":"Add track","operationId":"rmaTrackManagementV1AddTrackPost","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["track"],"properties":{"track":{"$ref":"#/definitions/rma-data-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaTrackManagementV1"],"description":"Get track list","operationId":"rmaTrackManagementV1GetTracksGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-track-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers/{trackId}":{"delete":{"tags":["rmaTrackManagementV1"],"description":"Remove track by id","operationId":"rmaTrackManagementV1RemoveTrackByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"trackId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/labels":{"get":{"tags":["rmaTrackManagementV1"],"description":"Get shipping label int the PDF format","operationId":"rmaTrackManagementV1GetShippingLabelPdfGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}":{"get":{"tags":["rmaRmaRepositoryV1"],"description":"Return data object for specified RMA id","operationId":"rmaRmaRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["rmaRmaRepositoryV1"],"description":"Delete RMA","operationId":"rmaRmaRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/comments":{"post":{"tags":["rmaCommentManagementV1"],"description":"Add comment","operationId":"rmaCommentManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/rma-data-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaCommentManagementV1"],"description":"Comments list","operationId":"rmaCommentManagementV1CommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns":{"post":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPost","parameters":[{"name":"$body","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaRmaManagementV1"],"description":"Return list of rma data objects based on search criteria","operationId":"rmaRmaManagementV1SearchGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/{attributeCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/form/{formCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve all attributes filtered by form code","operationId":"rmaRmaAttributesManagementV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get all attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/custom":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get custom attribute metadata for the given Data object's attribute set","operationId":"rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataObjectClassName","in":"query","type":"string","description":"Data object class name","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/framework-metadata-object-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/worldpay-guest-carts/{cartId}/payment-information":{"post":{"tags":["worldpayGuestPaymentInformationManagementProxyV1"],"description":"Proxy handler for guest place order","operationId":"worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"website_id":{"type":"integer"},"store_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","website_id","store_group_id"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"website_id":{"type":"integer"},"root_category_id":{"type":"integer"},"default_store_id":{"type":"integer"},"name":{"type":"string"},"extension_attributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","website_id","root_category_id","default_store_id","name"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"default_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","default_group_id"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"website_id":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"base_currency_code":{"type":"string","description":"Base currency code"},"default_display_currency_code":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weight_unit":{"type":"string","description":"The unit of weight"},"base_url":{"type":"string","description":"Base URL for the store"},"base_link_url":{"type":"string","description":"Base link URL for the store"},"base_static_url":{"type":"string","description":"Base static URL for the store"},"base_media_url":{"type":"string","description":"Base media URL for the store"},"secure_base_url":{"type":"string","description":"Secure base URL for the store"},"secure_base_link_url":{"type":"string","description":"Secure base link URL for the store"},"secure_base_static_url":{"type":"string","description":"Secure base static URL for the store"},"secure_base_media_url":{"type":"string","description":"Secure base media URL for the store"},"extension_attributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","website_id","locale","base_currency_code","default_display_currency_code","timezone","weight_unit","base_url","base_link_url","base_static_url","base_media_url","secure_base_url","secure_base_link_url","secure_base_static_url","secure_base_media_url"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"base_currency_code":{"type":"string","description":"The base currency code for the store."},"base_currency_symbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"default_display_currency_code":{"type":"string","description":"The default display currency code for the store."},"default_display_currency_symbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"available_currency_codes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchange_rates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["base_currency_code","base_currency_symbol","default_display_currency_code","default_display_currency_symbol","available_currency_codes","exchange_rates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currency_to":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extension_attributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currency_to","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"two_letter_abbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"three_letter_abbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"full_name_locale":{"type":"string","description":"The country full name (in store locale) for the store."},"full_name_english":{"type":"string","description":"The country full name (in English) for the store."},"available_regions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","two_letter_abbreviation","three_letter_abbreviation","full_name_locale","full_name_english"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extension_attributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"Interface AttributeSetSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["filter_groups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"condition_type":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"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-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontend_input":{"type":"string","description":"HTML for input element."},"input_filter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"store_label":{"type":"string","description":"Label of the store."},"validation_rules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multiline_count":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"data_model":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontend_class":{"type":"string","description":"Class which is used to display the attribute on frontend."},"user_defined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sort_order":{"type":"integer","description":"Attributes sort order."},"frontend_label":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backend_type":{"type":"string","description":"Backend type."},"is_used_in_grid":{"type":"boolean","description":"It is used in customer grid"},"is_visible_in_grid":{"type":"boolean","description":"It is visible in customer grid"},"is_filterable_in_grid":{"type":"boolean","description":"It is filterable in customer grid"},"is_searchable_in_grid":{"type":"boolean","description":"It is searchable in customer grid"},"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["frontend_input","input_filter","store_label","validation_rules","multiline_count","visible","required","data_model","options","frontend_class","user_defined","sort_order","frontend_label","note","system","backend_type","attribute_code"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"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":{"is_subscribed":{"type":"boolean"}}},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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":{"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"bundle_product_options":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}},"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"}},"configurable_product_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"configurable_product_links":{"type":"array","items":{"type":"integer"}}}},"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"},"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"},"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"},"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"},"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"},"catalog-data-product-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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","is_required","frontend_labels"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"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"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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","is_required","frontend_labels"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"Interface AttributeGroupSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-category-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"path":{"type":"string"},"available_sort_by":{"type":"array","items":{"type":"string"}},"include_in_menu":{"type":"boolean"},"extension_attributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"product_count":{"type":"integer","description":"Product count"},"children_data":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parent_id","name","is_active","position","level","product_count","children_data"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"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"]},"catalog-inventory-data-stock-status-collection-interface":{"type":"object","description":"Stock Status collection interface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"search_criteria":{"$ref":"#/definitions/catalog-inventory-stock-status-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"product_id":{"type":"integer"},"stock_id":{"type":"integer"},"qty":{"type":"integer"},"stock_status":{"type":"integer"},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["product_id","stock_id","qty","stock_status","stock_item"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"catalog-inventory-stock-status-criteria-interface":{"type":"object","description":"Interface StockStatusCriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extension_attributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"framework-search-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"search_criteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","aggregations","search_criteria","total_count"]},"framework-search-document-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucket_names":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucket_names"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"","properties":{"request_name":{"type":"string"},"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["request_name","filter_groups"]},"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":"integer","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"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcard_item_option":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-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"},"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"},"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"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface"},"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":{"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"}}}},"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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrier_code":{"type":"string","description":"Shipping carrier code."},"method_code":{"type":"string","description":"Shipping method code."},"carrier_title":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"method_title":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"base_amount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"error_message":{"type":"string","description":"Shipping Error message."},"price_excl_tax":{"type":"number","description":"Shipping price excl tax."},"price_incl_tax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrier_code","method_code","amount","base_amount","available","error_message","price_excl_tax","price_incl_tax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grand_total":{"type":"number","description":"Grand total in quote currency"},"base_grand_total":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"base_subtotal":{"type":"number","description":"Subtotal in base currency"},"discount_amount":{"type":"number","description":"Discount amount in quote currency"},"base_discount_amount":{"type":"number","description":"Discount amount in base currency"},"subtotal_with_discount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"base_subtotal_with_discount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shipping_amount":{"type":"number","description":"Shipping amount in quote currency"},"base_shipping_amount":{"type":"number","description":"Shipping amount in base currency"},"shipping_discount_amount":{"type":"number","description":"Shipping discount amount in quote currency"},"base_shipping_discount_amount":{"type":"number","description":"Shipping discount amount in base currency"},"tax_amount":{"type":"number","description":"Tax amount in quote currency"},"base_tax_amount":{"type":"number","description":"Tax amount in base currency"},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount in quote currency"},"base_shipping_tax_amount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in quote currency"},"base_subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in base currency"},"shipping_incl_tax":{"type":"number","description":"Shipping including tax in quote currency"},"base_shipping_incl_tax":{"type":"number","description":"Shipping including tax in base currency"},"base_currency_code":{"type":"string","description":"Base currency code"},"quote_currency_code":{"type":"string","description":"Quote currency code"},"coupon_code":{"type":"string","description":"Applied coupon code"},"items_qty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"total_segments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weee_tax_applied_amount","total_segments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"item_id":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"base_price":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"row_total":{"type":"number","description":"Row total in quote currency."},"base_row_total":{"type":"number","description":"Row total in base currency."},"row_total_with_discount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"tax_amount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"base_tax_amount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"tax_percent":{"type":"number","description":"Tax percent. Otherwise, null."},"discount_amount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"base_discount_amount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discount_percent":{"type":"number","description":"Discount percent. Otherwise, null."},"price_incl_tax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"base_price_incl_tax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"row_total_incl_tax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"base_row_total_incl_tax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weee_tax_applied":{"type":"string","description":"Item weee tax applied in quote currency."},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["item_id","price","base_price","qty","row_total","base_row_total","options","weee_tax_applied_amount","weee_tax_applied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extension_attributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"tax_grandtotal_details":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}},"gift_cards":{"type":"string"},"gw_order_id":{"type":"string"},"gw_item_ids":{"type":"array","items":{"type":"string"}},"gw_allow_gift_receipt":{"type":"string"},"gw_add_card":{"type":"string"},"gw_price":{"type":"string"},"gw_base_price":{"type":"string"},"gw_items_price":{"type":"string"},"gw_items_base_price":{"type":"string"},"gw_card_price":{"type":"string"},"gw_card_base_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_price_incl_tax":{"type":"string"},"gw_base_price_incl_tax":{"type":"string"},"gw_card_price_incl_tax":{"type":"string"},"gw_card_base_price_incl_tax":{"type":"string"},"gw_items_price_incl_tax":{"type":"string"},"gw_items_base_price_incl_tax":{"type":"string"}}},"tax-data-grand-total-details-interface":{"type":"object","description":"Interface GrandTotalDetailsInterface","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"group_id":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","group_id"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"Interface GrandTotalRatesInterface","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface","properties":{"base_customer_balance_amount":{"type":"number"},"customer_balance_amount":{"type":"number"},"reward_points_balance":{"type":"number"},"reward_currency_amount":{"type":"number"},"base_reward_currency_amount":{"type":"number"}}},"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"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcard_item_option":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-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"}}},"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"}},"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"},"base_customer_balance_amount":{"type":"number"},"customer_balance_amount":{"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_price":{"type":"string"},"gw_base_price":{"type":"string"},"gw_items_price":{"type":"string"},"gw_items_base_price":{"type":"string"},"gw_card_price":{"type":"string"},"gw_card_base_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_price_incl_tax":{"type":"string"},"gw_base_price_incl_tax":{"type":"string"},"gw_card_price_incl_tax":{"type":"string"},"gw_card_base_price_incl_tax":{"type":"string"},"gw_items_price_incl_tax":{"type":"string"},"gw_items_base_price_incl_tax":{"type":"string"}}},"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"},"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"},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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"}}},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-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"},"sales-data-creditmemo-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoInterface"},"sales-data-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transaction_id":{"type":"integer","description":"Transaction ID."},"parent_id":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"order_id":{"type":"integer","description":"Order ID."},"payment_id":{"type":"integer","description":"Payment ID."},"txn_id":{"type":"string","description":"Transaction business ID."},"parent_txn_id":{"type":"string","description":"Parent transaction business ID."},"txn_type":{"type":"string","description":"Transaction type."},"is_closed":{"type":"integer","description":"Is-closed flag value."},"additional_information":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"created_at":{"type":"string","description":"Created-at timestamp."},"child_transactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transaction_id","order_id","payment_id","txn_id","parent_txn_id","txn_type","is_closed","created_at","child_transactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failed_items":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missing_items":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failed_items","missing_items"]},"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-payment-details-interface":{"type":"object","description":"Interface PaymentDetailsInterface","properties":{"payment_methods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extension_attributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["payment_methods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"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"},"checkout-agreements-data-agreement-interface":{"type":"object","description":"Interface AgreementInterface","properties":{"agreement_id":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"content_height":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkbox_text":{"type":"string","description":"Agreement checkbox text."},"is_active":{"type":"boolean","description":"Agreement status."},"is_html":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extension_attributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreement_id","name","content","checkbox_text","is_active","is_html","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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","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"},"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"},"gift-wrapping-data-wrapping-search-results-interface":{"type":"object","description":"Interface WrappingSearchResultsInterface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-track-search-result-interface":{"type":"object","description":"Interface TrackSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-track-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"rma-data-comment-search-result-interface":{"type":"object","description":"Interface CommentSearchResultInterface","properties":{"items":{"type":"array","description":"Rma Status History list","items":{"$ref":"#/definitions/rma-data-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"rma-data-rma-search-result-interface":{"type":"object","description":"Interface RmaSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-rma-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"framework-metadata-object-interface":{"type":"object","description":"Provides metadata about an attribute.","properties":{"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["attribute_code"]}}} diff --git a/src/swagger/schemas/latest-2.2.schema.json b/src/swagger/schemas/latest-2.2.schema.json deleted file mode 100644 index 09d313d4dca..00000000000 --- a/src/swagger/schemas/latest-2.2.schema.json +++ /dev/null @@ -1,39760 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2.2.10", - "title": "Magento B2B" - }, - "host": "example.com", - "basePath": "/rest/default", - "schemes": [ - "https" - ], - "tags": [ - { - "name": "storeStoreRepositoryV1", - "description": "Store repository interface" - }, - { - "name": "storeGroupRepositoryV1", - "description": "Group repository interface" - }, - { - "name": "storeWebsiteRepositoryV1", - "description": "Website repository interface" - }, - { - "name": "storeStoreConfigManagerV1", - "description": "Store config manager interface" - }, - { - "name": "directoryCurrencyInformationAcquirerV1", - "description": "Currency information acquirer interface" - }, - { - "name": "directoryCountryInformationAcquirerV1", - "description": "Country information acquirer interface" - }, - { - "name": "eavAttributeSetRepositoryV1", - "description": "Interface AttributeSetRepositoryInterface" - }, - { - "name": "eavAttributeSetManagementV1", - "description": "Interface AttributeSetManagementInterface" - }, - { - "name": "customerGroupRepositoryV1", - "description": "Customer group CRUD interface" - }, - { - "name": "customerGroupManagementV1", - "description": "Interface for managing customer groups." - }, - { - "name": "customerCustomerGroupConfigV1", - "description": "Interface for system configuration operations for customer groups." - }, - { - "name": "customerCustomerMetadataV1", - "description": "Interface for retrieval information about customer attributes metadata." - }, - { - "name": "customerAddressMetadataV1", - "description": "Interface for retrieval information about customer address attributes metadata." - }, - { - "name": "customerCustomerRepositoryV1", - "description": "Customer CRUD interface." - }, - { - "name": "customerAccountManagementV1", - "description": "Interface for managing customers accounts." - }, - { - "name": "customerAddressRepositoryV1", - "description": "Customer address CRUD interface." - }, - { - "name": "backendModuleServiceV1", - "description": "Interface for module service." - }, - { - "name": "cmsPageRepositoryV1", - "description": "CMS page CRUD interface." - }, - { - "name": "cmsBlockRepositoryV1", - "description": "CMS block CRUD interface." - }, - { - "name": "catalogProductRepositoryV1", - "description": "" - }, - { - "name": "catalogProductAttributeTypesListV1", - "description": "" - }, - { - "name": "catalogProductAttributeRepositoryV1", - "description": "Interface RepositoryInterface must be implemented in new model" - }, - { - "name": "catalogCategoryAttributeRepositoryV1", - "description": "Interface RepositoryInterface must be implemented in new model" - }, - { - "name": "catalogCategoryAttributeOptionManagementV1", - "description": "Interface RepositoryInterface must be implemented in new model" - }, - { - "name": "catalogProductTypeListV1", - "description": "" - }, - { - "name": "catalogAttributeSetRepositoryV1", - "description": "" - }, - { - "name": "catalogAttributeSetManagementV1", - "description": "" - }, - { - "name": "catalogProductAttributeManagementV1", - "description": "" - }, - { - "name": "catalogProductAttributeGroupRepositoryV1", - "description": "" - }, - { - "name": "catalogProductAttributeOptionManagementV1", - "description": "" - }, - { - "name": "catalogProductMediaAttributeManagementV1", - "description": "" - }, - { - "name": "catalogProductAttributeMediaGalleryManagementV1", - "description": "" - }, - { - "name": "catalogProductTierPriceManagementV1", - "description": "" - }, - { - "name": "catalogTierPriceStorageV1", - "description": "Tier prices storage." - }, - { - "name": "catalogBasePriceStorageV1", - "description": "Base prices storage." - }, - { - "name": "catalogCostStorageV1", - "description": "Product cost storage." - }, - { - "name": "catalogSpecialPriceStorageV1", - "description": "Special price storage presents efficient price API and is used to retrieve, update or delete special prices." - }, - { - "name": "catalogCategoryRepositoryV1", - "description": "" - }, - { - "name": "catalogCategoryManagementV1", - "description": "" - }, - { - "name": "catalogCategoryListV1", - "description": "" - }, - { - "name": "catalogProductCustomOptionTypeListV1", - "description": "" - }, - { - "name": "catalogProductCustomOptionRepositoryV1", - "description": "" - }, - { - "name": "catalogProductLinkTypeListV1", - "description": "" - }, - { - "name": "catalogProductLinkManagementV1", - "description": "" - }, - { - "name": "catalogProductLinkRepositoryV1", - "description": "Interface Product links handling interface" - }, - { - "name": "catalogCategoryLinkManagementV1", - "description": "" - }, - { - "name": "catalogCategoryLinkRepositoryV1", - "description": "" - }, - { - "name": "catalogProductWebsiteLinkRepositoryV1", - "description": "Interface ProductWebsiteLinkRepositoryInterface" - }, - { - "name": "catalogProductRenderListV1", - "description": "Interface which provides product renders information for products" - }, - { - "name": "quoteCartRepositoryV1", - "description": "Interface CartRepositoryInterface" - }, - { - "name": "quoteCartManagementV1", - "description": "Interface CartManagementInterface" - }, - { - "name": "quoteGuestCartRepositoryV1", - "description": "Cart Repository interface for guest carts." - }, - { - "name": "quoteGuestCartManagementV1", - "description": "Cart Management interface for guest carts." - }, - { - "name": "quoteShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "quoteShipmentEstimationV1", - "description": "Interface ShipmentManagementInterface" - }, - { - "name": "quoteGuestShippingMethodManagementV1", - "description": "Shipping method management interface for guest carts." - }, - { - "name": "quoteGuestShipmentEstimationV1", - "description": "Interface GuestShipmentEstimationInterface" - }, - { - "name": "quoteCartItemRepositoryV1", - "description": "Interface CartItemRepositoryInterface" - }, - { - "name": "quoteGuestCartItemRepositoryV1", - "description": "Cart Item repository interface for guest carts." - }, - { - "name": "quotePaymentMethodManagementV1", - "description": "Interface PaymentMethodManagementInterface" - }, - { - "name": "quoteGuestPaymentMethodManagementV1", - "description": "Payment method management interface for guest carts." - }, - { - "name": "quoteBillingAddressManagementV1", - "description": "Interface BillingAddressManagementInterface" - }, - { - "name": "quoteGuestBillingAddressManagementV1", - "description": "Billing address management interface for guest carts." - }, - { - "name": "quoteCouponManagementV1", - "description": "Coupon management service interface." - }, - { - "name": "quoteGuestCouponManagementV1", - "description": "Coupon management interface for guest carts." - }, - { - "name": "quoteCartTotalRepositoryV1", - "description": "Interface CartTotalRepositoryInterface" - }, - { - "name": "quoteGuestCartTotalManagementV1", - "description": "Bundled API to collect totals for cart based on shipping/payment methods and additional data." - }, - { - "name": "quoteGuestCartTotalRepositoryV1", - "description": "Cart totals repository interface for guest carts." - }, - { - "name": "quoteCartTotalManagementV1", - "description": "Bundled API to collect totals for cart based on shipping/payment methods and additional data." - }, - { - "name": "bundleProductLinkManagementV1", - "description": "Interface for Management of ProductLink" - }, - { - "name": "bundleProductOptionRepositoryV1", - "description": "Interface ProductOptionRepositoryInterface" - }, - { - "name": "bundleProductOptionTypeListV1", - "description": "Interface ProductOptionTypeListInterface" - }, - { - "name": "bundleProductOptionManagementV1", - "description": "Option manager for bundle products" - }, - { - "name": "requisitionListRequisitionListRepositoryV1", - "description": "Interface RequisitionListRepositoryInterface" - }, - { - "name": "searchV1", - "description": "Search API for all requests" - }, - { - "name": "catalogInventoryStockRegistryV1", - "description": "Interface StockRegistryInterface" - }, - { - "name": "salesOrderRepositoryV1", - "description": "Order repository 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." - }, - { - "name": "salesOrderManagementV1", - "description": "Order management 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." - }, - { - "name": "salesOrderAddressRepositoryV1", - "description": "Order address repository 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." - }, - { - "name": "salesOrderItemRepositoryV1", - "description": "Order item repository 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." - }, - { - "name": "salesInvoiceRepositoryV1", - "description": "Invoice repository interface. An invoice is a record of the receipt of payment for an order." - }, - { - "name": "salesInvoiceManagementV1", - "description": "Invoice management interface. An invoice is a record of the receipt of payment for an order." - }, - { - "name": "salesInvoiceCommentRepositoryV1", - "description": "Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history." - }, - { - "name": "salesRefundInvoiceV1", - "description": "Interface RefundInvoiceInterface" - }, - { - "name": "salesCreditmemoManagementV1", - "description": "Credit memo add 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." - }, - { - "name": "salesCreditmemoRepositoryV1", - "description": "Credit memo repository 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." - }, - { - "name": "salesCreditmemoCommentRepositoryV1", - "description": "Credit memo comment repository 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." - }, - { - "name": "salesRefundOrderV1", - "description": "Interface RefundOrderInterface" - }, - { - "name": "salesShipmentRepositoryV1", - "description": "Shipment repository 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." - }, - { - "name": "salesShipmentManagementV1", - "description": "Shipment management 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." - }, - { - "name": "salesShipmentCommentRepositoryV1", - "description": "Shipment comment repository 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." - }, - { - "name": "salesShipmentTrackRepositoryV1", - "description": "Shipment track repository 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." - }, - { - "name": "salesShipOrderV1", - "description": "Class ShipOrderInterface" - }, - { - "name": "salesTransactionRepositoryV1", - "description": "Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on." - }, - { - "name": "salesInvoiceOrderV1", - "description": "Class InvoiceOrderInterface" - }, - { - "name": "checkoutGuestShippingInformationManagementV1", - "description": "Interface for managing guest shipping address information" - }, - { - "name": "checkoutShippingInformationManagementV1", - "description": "Interface for managing customer shipping address information" - }, - { - "name": "checkoutTotalsInformationManagementV1", - "description": "Interface for quote totals calculation" - }, - { - "name": "checkoutGuestTotalsInformationManagementV1", - "description": "Interface for guest quote totals calculation" - }, - { - "name": "checkoutGuestPaymentInformationManagementV1", - "description": "Interface for managing guest payment information" - }, - { - "name": "checkoutPaymentInformationManagementV1", - "description": "Interface for managing quote payment information" - }, - { - "name": "salesRuleRuleRepositoryV1", - "description": "Sales rule CRUD interface" - }, - { - "name": "salesRuleCouponRepositoryV1", - "description": "Coupon CRUD interface" - }, - { - "name": "salesRuleCouponManagementV1", - "description": "Coupon management interface" - }, - { - "name": "configurableProductLinkManagementV1", - "description": "Manage children products of configurable product" - }, - { - "name": "configurableProductConfigurableProductManagementV1", - "description": "Interface ConfigurableProductManagementInterface" - }, - { - "name": "configurableProductOptionRepositoryV1", - "description": "Manage options of configurable product" - }, - { - "name": "downloadableLinkRepositoryV1", - "description": "Interface LinkRepositoryInterface" - }, - { - "name": "downloadableSampleRepositoryV1", - "description": "Interface SampleRepositoryInterface" - }, - { - "name": "checkoutAgreementsCheckoutAgreementsRepositoryV1", - "description": "Interface CheckoutAgreementsRepositoryInterface" - }, - { - "name": "taxTaxRateRepositoryV1", - "description": "Tax rate CRUD interface." - }, - { - "name": "taxTaxRuleRepositoryV1", - "description": "Tax rule CRUD interface." - }, - { - "name": "taxTaxClassRepositoryV1", - "description": "Tax class CRUD interface." - }, - { - "name": "companyCompanyRepositoryV1", - "description": "A repository interface for company entity that provides basic CRUD operations." - }, - { - "name": "companyTeamRepositoryV1", - "description": "Interface for basic CRUD operations for team entity." - }, - { - "name": "companyCompanyHierarchyV1", - "description": "Interface for working with company hierarchy." - }, - { - "name": "companyRoleRepositoryV1", - "description": "A repository interface for role entity that provides basic CRUD operations." - }, - { - "name": "companyAclV1", - "description": "Access control list interface." - }, - { - "name": "integrationAdminTokenServiceV1", - "description": "Interface providing token generation for Admins" - }, - { - "name": "integrationCustomerTokenServiceV1", - "description": "Interface providing token generation for Customers" - }, - { - "name": "analyticsLinkProviderV1", - "description": "Provides link to file with collected report data." - }, - { - "name": "customerBalanceBalanceManagementFromQuoteV1", - "description": "Customer balance(store credit) operations." - }, - { - "name": "negotiableQuoteNegotiableQuoteManagementV1", - "description": "Interface for managing quotes." - }, - { - "name": "negotiableQuoteNegotiableQuotePriceManagementV1", - "description": "Interface for updating quote prices in case price changes occur in system." - }, - { - "name": "negotiableQuoteAttachmentContentManagementV1", - "description": "Interface for retrieving the list of negotiable quotes attachments." - }, - { - "name": "negotiableQuoteCommentLocatorV1", - "description": "Interface for load quote comments with attachment." - }, - { - "name": "negotiableQuoteNegotiableQuoteShippingManagementV1", - "description": "Interface for add and update negotiable quote shipping method." - }, - { - "name": "negotiableQuotePaymentInformationManagementV1", - "description": "Interface for managing quote payment information" - }, - { - "name": "negotiableQuoteShippingInformationManagementV1", - "description": "Interface for managing customer shipping address information" - }, - { - "name": "negotiableQuoteShipmentEstimationV1", - "description": "Interface ShipmentManagementInterface" - }, - { - "name": "negotiableQuoteShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "negotiableQuoteNegotiableCartRepositoryV1", - "description": "Interface is intended to be used in webapi only. For other cases CartRepositoryInterface should be used." - }, - { - "name": "negotiableQuoteBillingAddressManagementV1", - "description": "Interface BillingAddressManagementInterface" - }, - { - "name": "negotiableQuoteCartTotalRepositoryV1", - "description": "Interface CartTotalRepositoryInterface" - }, - { - "name": "negotiableQuoteCouponManagementV1", - "description": "Coupon management service interface." - }, - { - "name": "negotiableQuoteGiftCardAccountManagementV1", - "description": "Interface GiftCardAccountManagementInterface" - }, - { - "name": "giftCardAccountGiftCardAccountManagementV1", - "description": "Interface GiftCardAccountManagementInterface" - }, - { - "name": "giftCardAccountGuestGiftCardAccountManagementV1", - "description": "Interface GuestGiftCardAccountManagementInterface" - }, - { - "name": "sharedCatalogSharedCatalogRepositoryV1", - "description": "" - }, - { - "name": "sharedCatalogCompanyManagementV1", - "description": "Shared catalog companies actions." - }, - { - "name": "sharedCatalogProductManagementV1", - "description": "Shared catalog products actions." - }, - { - "name": "sharedCatalogCategoryManagementV1", - "description": "Shared catalog products actions." - }, - { - "name": "giftMessageCartRepositoryV1", - "description": "Interface CartRepositoryInterface" - }, - { - "name": "giftMessageItemRepositoryV1", - "description": "Interface ItemRepositoryInterface" - }, - { - "name": "giftMessageGuestCartRepositoryV1", - "description": "Interface GuestCartRepositoryInterface" - }, - { - "name": "giftMessageGuestItemRepositoryV1", - "description": "Interface GuestItemRepositoryInterface" - }, - { - "name": "giftRegistryShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "giftRegistryGuestCartShippingMethodManagementV1", - "description": "Interface ShippingMethodManagementInterface" - }, - { - "name": "giftWrappingWrappingRepositoryV1", - "description": "Interface WrappingRepositoryInterface" - }, - { - "name": "rewardRewardManagementV1", - "description": "Interface RewardManagementInterface" - }, - { - "name": "rmaTrackManagementV1", - "description": "Interface TrackManagementInterface" - }, - { - "name": "rmaRmaRepositoryV1", - "description": "Interface RmaRepositoryInterface" - }, - { - "name": "rmaCommentManagementV1", - "description": "Interface CommentRepositoryInterface" - }, - { - "name": "rmaRmaManagementV1", - "description": "Interface RmaManagementInterface" - }, - { - "name": "rmaRmaAttributesManagementV1", - "description": "Interface RmaAttributesManagementInterface" - }, - { - "name": "companyCreditCreditLimitRepositoryV1", - "description": "Interface for credit limit repository for CRUD operations." - }, - { - "name": "companyCreditCreditLimitManagementV1", - "description": "Credit Limit management interface." - }, - { - "name": "companyCreditCreditBalanceManagementV1", - "description": "Interface for management decrease and increase credit balance operations." - }, - { - "name": "companyCreditCreditHistoryManagementV1", - "description": "Update credit history log and retrieve history which match a specified criteria." - }, - { - "name": "asynchronousOperationsBulkStatusV1", - "description": "Interface BulkStatusInterface Bulk summary data with list of operations items short data." - }, - { - "name": "worldpayGuestPaymentInformationManagementProxyV1", - "description": "Interface GuestPaymentInformationManagementProxyInterface" - }, - { - "name": "amazonPaymentAddressManagementV1", - "description": "" - }, - { - "name": "amazonPaymentOrderInformationManagementV1", - "description": "" - }, - { - "name": "temandoShippingQuoteCartDeliveryOptionManagementV1", - "description": "CartDeliveryOptionManagementInterface" - }, - { - "name": "temandoShippingQuoteGuestCartDeliveryOptionManagementV1", - "description": "GuestCartDeliveryOptionManagementInterface" - }, - { - "name": "temandoShippingRmaRmaShipmentManagementV1", - "description": "Manage RMA Shipments" - }, - { - "name": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1", - "description": "Process Collection Point Search (Guest Checkout)" - }, - { - "name": "temandoShippingCollectionPointCartCollectionPointManagementV1", - "description": "Process Collection Point Search" - }, - { - "name": "temandoShippingQuoteGuestCartCheckoutFieldManagementV1", - "description": "Interface GuestCartCheckoutFieldManagementInterface Persist value-added services as selected during guest checkout." - }, - { - "name": "temandoShippingQuoteCartCheckoutFieldManagementV1", - "description": "Interface CartCheckoutFieldManagementInterface Persist value-added services as selected during logged-in checkout." - } - ], - "paths": { - "/V1/store/storeViews": { - "get": { - "tags": [ - "storeStoreRepositoryV1" - ], - "description": "Retrieve list of all stores", - "operationId": "storeStoreRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-store-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/store/storeGroups": { - "get": { - "tags": [ - "storeGroupRepositoryV1" - ], - "description": "Retrieve list of all groups", - "operationId": "storeGroupRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-group-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/store/websites": { - "get": { - "tags": [ - "storeWebsiteRepositoryV1" - ], - "description": "Retrieve list of all websites", - "operationId": "storeWebsiteRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-website-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/store/storeConfigs": { - "get": { - "tags": [ - "storeStoreConfigManagerV1" - ], - "description": "", - "operationId": "storeStoreConfigManagerV1GetStoreConfigsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "storeCodes", - "in": "query", - "type": "array", - "items": { - "type": "string" - }, - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/store-data-store-config-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/directory/currency": { - "get": { - "tags": [ - "directoryCurrencyInformationAcquirerV1" - ], - "description": "Get currency information for the store.", - "operationId": "directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/directory-data-currency-information-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/directory/countries": { - "get": { - "tags": [ - "directoryCountryInformationAcquirerV1" - ], - "description": "Get all countries and regions information for the store.", - "operationId": "directoryCountryInformationAcquirerV1GetCountriesInfoGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/directory-data-country-information-interface" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/directory/countries/{countryId}": { - "get": { - "tags": [ - "directoryCountryInformationAcquirerV1" - ], - "description": "Get country and region information for the store.", - "operationId": "directoryCountryInformationAcquirerV1GetCountryInfoGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "countryId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/directory-data-country-information-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/eav/attribute-sets/list": { - "get": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "description": "Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "eavAttributeSetRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/eav/attribute-sets/{attributeSetId}": { - "get": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "description": "Retrieve attribute set information based on given ID", - "operationId": "eavAttributeSetRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "eavAttributeSetRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/eav/attribute-sets": { - "post": { - "tags": [ - "eavAttributeSetManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/{id}": { - "get": { - "tags": [ - "customerGroupRepositoryV1" - ], - "description": "Get customer group by group ID.", - "operationId": "customerGroupRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "customerGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "customerGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/search": { - "get": { - "tags": [ - "customerGroupRepositoryV1" - ], - "description": "Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "customerGroupRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups": { - "post": { - "tags": [ - "customerGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/default/{storeId}": { - "get": { - "tags": [ - "customerGroupManagementV1" - ], - "description": "Get default customer group.", - "operationId": "customerGroupManagementV1GetDefaultGroupGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "storeId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/default": { - "get": { - "tags": [ - "customerGroupManagementV1" - ], - "description": "Get default customer group.", - "operationId": "customerGroupManagementV1GetDefaultGroupGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/{id}/permissions": { - "get": { - "tags": [ - "customerGroupManagementV1" - ], - "description": "Check if customer group can be deleted.", - "operationId": "customerGroupManagementV1IsReadonlyGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customerGroups/default/{id}": { - "put": { - "tags": [ - "customerCustomerGroupConfigV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer/attribute/{attributeCode}": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Retrieve attribute metadata.", - "operationId": "customerCustomerMetadataV1GetAttributeMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer/form/{formCode}": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Retrieve all attributes filtered by form code", - "operationId": "customerCustomerMetadataV1GetAttributesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "formCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Get all attribute metadata.", - "operationId": "customerCustomerMetadataV1GetAllAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customer/custom": { - "get": { - "tags": [ - "customerCustomerMetadataV1" - ], - "description": "Get custom attributes metadata for the given data interface.", - "operationId": "customerCustomerMetadataV1GetCustomAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "dataInterfaceName", - "in": "query", - "type": "string", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress/attribute/{attributeCode}": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Retrieve attribute metadata.", - "operationId": "customerAddressMetadataV1GetAttributeMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress/form/{formCode}": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Retrieve all attributes filtered by form code", - "operationId": "customerAddressMetadataV1GetAttributesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "formCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Get all attribute metadata.", - "operationId": "customerAddressMetadataV1GetAllAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/attributeMetadata/customerAddress/custom": { - "get": { - "tags": [ - "customerAddressMetadataV1" - ], - "description": "Get custom attributes metadata for the given data interface.", - "operationId": "customerAddressMetadataV1GetCustomAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "dataInterfaceName", - "in": "query", - "type": "string", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}": { - "get": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Get customer by Customer ID.", - "operationId": "customerCustomerRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me": { - "put": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Get customer by Customer ID.", - "operationId": "customerCustomerRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/search": { - "get": { - "tags": [ - "customerCustomerRepositoryV1" - ], - "description": "Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "customerCustomerRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/activate": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{email}/activate": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/password": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Check if password reset token is valid.", - "operationId": "customerAccountManagementV1ValidateResetPasswordLinkTokenGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true, - "description": "If 0 is given then a customer will be matched by the RP token." - }, - { - "name": "resetPasswordLinkToken", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "True if the token is valid" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/password": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/resetPassword": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/confirm": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Gets the account confirmation status.", - "operationId": "customerAccountManagementV1GetConfirmationStatusGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/confirm": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/validate": { - "put": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-validation-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/permissions/readonly": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Check if customer can be deleted.", - "operationId": "customerAccountManagementV1IsReadonlyGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/isEmailAvailable": { - "post": { - "tags": [ - "customerAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/billingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default billing address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultBillingAddressGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/billingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default billing address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultBillingAddressGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/me/shippingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default shipping address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultShippingAddressGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/shippingAddress": { - "get": { - "tags": [ - "customerAccountManagementV1" - ], - "description": "Retrieve default shipping address for the given customerId.", - "operationId": "customerAccountManagementV1GetDefaultShippingAddressGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "customerId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/addresses/{addressId}": { - "get": { - "tags": [ - "customerAddressRepositoryV1" - ], - "description": "Retrieve customer address.", - "operationId": "customerAddressRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "addressId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/addresses/{addressId}": { - "delete": { - "tags": [ - "customerAddressRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/modules": { - "get": { - "tags": [ - "backendModuleServiceV1" - ], - "description": "Returns an array of enabled modules", - "operationId": "backendModuleServiceV1GetModulesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage/{pageId}": { - "get": { - "tags": [ - "cmsPageRepositoryV1" - ], - "description": "Retrieve page.", - "operationId": "cmsPageRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "pageId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "cmsPageRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage/search": { - "get": { - "tags": [ - "cmsPageRepositoryV1" - ], - "description": "Retrieve pages matching the specified criteria.", - "operationId": "cmsPageRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage": { - "post": { - "tags": [ - "cmsPageRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsPage/{id}": { - "put": { - "tags": [ - "cmsPageRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock/{blockId}": { - "get": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "description": "Retrieve block.", - "operationId": "cmsBlockRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "blockId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock/search": { - "get": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "description": "Retrieve blocks matching the specified criteria.", - "operationId": "cmsBlockRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock": { - "post": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/cmsBlock/{id}": { - "put": { - "tags": [ - "cmsBlockRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products": { - "post": { - "tags": [ - "catalogProductRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogProductRepositoryV1" - ], - "description": "Get product list", - "operationId": "catalogProductRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}": { - "put": { - "tags": [ - "catalogProductRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductRepositoryV1" - ], - "description": "", - "operationId": "catalogProductRepositoryV1DeleteByIdDelete", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "Will returned True if deleted" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogProductRepositoryV1" - ], - "description": "Get info about product by product SKU", - "operationId": "catalogProductRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "editMode", - "in": "query", - "type": "boolean", - "required": false - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - }, - { - "name": "forceReload", - "in": "query", - "type": "boolean", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/types": { - "get": { - "tags": [ - "catalogProductAttributeTypesListV1" - ], - "description": "Retrieve list of product attribute types", - "operationId": "catalogProductAttributeTypesListV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/{attributeCode}": { - "get": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "description": "Retrieve specific attribute", - "operationId": "catalogProductAttributeRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes": { - "get": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "description": "Retrieve all attributes for entity type", - "operationId": "catalogProductAttributeRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "catalogProductAttributeRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/attributes/{attributeCode}": { - "get": { - "tags": [ - "catalogCategoryAttributeRepositoryV1" - ], - "description": "Retrieve specific attribute", - "operationId": "catalogCategoryAttributeRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-attribute-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/attributes": { - "get": { - "tags": [ - "catalogCategoryAttributeRepositoryV1" - ], - "description": "Retrieve all attributes for entity type", - "operationId": "catalogCategoryAttributeRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-attribute-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/attributes/{attributeCode}/options": { - "get": { - "tags": [ - "catalogCategoryAttributeOptionManagementV1" - ], - "description": "Retrieve list of attribute options", - "operationId": "catalogCategoryAttributeOptionManagementV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/eav-data-attribute-option-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/types": { - "get": { - "tags": [ - "catalogProductTypeListV1" - ], - "description": "Retrieve available product types", - "operationId": "catalogProductTypeListV1GetProductTypesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/sets/list": { - "get": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "description": "Retrieve list of Attribute Sets", - "operationId": "catalogAttributeSetRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}": { - "get": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "description": "Retrieve attribute set information based on given ID", - "operationId": "catalogAttributeSetRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogAttributeSetRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets": { - "post": { - "tags": [ - "catalogAttributeSetManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}/attributes": { - "get": { - "tags": [ - "catalogProductAttributeManagementV1" - ], - "description": "Retrieve related attributes based on given attribute set ID", - "operationId": "catalogProductAttributeManagementV1GetAttributesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeSetId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/attributes": { - "post": { - "tags": [ - "catalogProductAttributeManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}": { - "delete": { - "tags": [ - "catalogProductAttributeManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/groups/list": { - "get": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "description": "Retrieve list of attribute groups", - "operationId": "catalogProductAttributeGroupRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-group-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/groups": { - "post": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/{attributeSetId}/groups": { - "put": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/eav-data-attribute-group-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attribute-sets/groups/{groupId}": { - "delete": { - "tags": [ - "catalogProductAttributeGroupRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/{attributeCode}/options": { - "get": { - "tags": [ - "catalogProductAttributeOptionManagementV1" - ], - "description": "Retrieve list of attribute options", - "operationId": "catalogProductAttributeOptionManagementV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/eav-data-attribute-option-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "catalogProductAttributeOptionManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/attributes/{attributeCode}/options/{optionId}": { - "delete": { - "tags": [ - "catalogProductAttributeOptionManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/media/types/{attributeSetName}": { - "get": { - "tags": [ - "catalogProductMediaAttributeManagementV1" - ], - "description": "Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.", - "operationId": "catalogProductMediaAttributeManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeSetName", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "list of media attributes", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/media/{entryId}": { - "get": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "description": "Return information about gallery entry", - "operationId": "catalogProductAttributeMediaGalleryManagementV1GetGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/media": { - "post": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "gallery entry ID" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogProductAttributeMediaGalleryManagementV1" - ], - "description": "Retrieve the list of gallery entries associated with given product", - "operationId": "catalogProductAttributeMediaGalleryManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-media-gallery-entry-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers": { - "get": { - "tags": [ - "catalogProductTierPriceManagementV1" - ], - "description": "Get tier price of product", - "operationId": "catalogProductTierPriceManagementV1GetListGet", - "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'" - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-tier-price-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}": { - "post": { - "tags": [ - "catalogProductTierPriceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}": { - "delete": { - "tags": [ - "catalogProductTierPriceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/tier-prices-information": { - "post": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-tier-price-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/tier-prices": { - "post": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/tier-prices-delete": { - "post": { - "tags": [ - "catalogTierPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/base-prices-information": { - "post": { - "tags": [ - "catalogBasePriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-base-price-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/base-prices": { - "post": { - "tags": [ - "catalogBasePriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/cost-information": { - "post": { - "tags": [ - "catalogCostStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-cost-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/cost": { - "post": { - "tags": [ - "catalogCostStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/cost-delete": { - "post": { - "tags": [ - "catalogCostStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "Will return True if deleted." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/special-price-information": { - "post": { - "tags": [ - "catalogSpecialPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-special-price-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/special-price": { - "post": { - "tags": [ - "catalogSpecialPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/special-price-delete": { - "post": { - "tags": [ - "catalogSpecialPriceStorageV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-price-update-result-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}": { - "delete": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "Will returned True if deleted" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "description": "Get info about category by category id", - "operationId": "catalogCategoryRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "categoryId", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories": { - "post": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "catalogCategoryManagementV1" - ], - "description": "Retrieve list of categories", - "operationId": "catalogCategoryManagementV1GetTreeGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "rootCategoryId", - "in": "query", - "type": "integer", - "required": false - }, - { - "name": "depth", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-tree-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{id}": { - "put": { - "tags": [ - "catalogCategoryRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}/move": { - "put": { - "tags": [ - "catalogCategoryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/list": { - "get": { - "tags": [ - "catalogCategoryListV1" - ], - "description": "Get category list", - "operationId": "catalogCategoryListV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-category-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/options/types": { - "get": { - "tags": [ - "catalogProductCustomOptionTypeListV1" - ], - "description": "Get custom option types", - "operationId": "catalogProductCustomOptionTypeListV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-custom-option-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/options": { - "get": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "description": "Get the list of custom options for a specific product", - "operationId": "catalogProductCustomOptionRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/options/{optionId}": { - "get": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "description": "Get custom option for a specific product", - "operationId": "catalogProductCustomOptionRepositoryV1GetGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/options": { - "post": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/options/{optionId}": { - "put": { - "tags": [ - "catalogProductCustomOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-custom-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/links/types": { - "get": { - "tags": [ - "catalogProductLinkTypeListV1" - ], - "description": "Retrieve information about available product link types", - "operationId": "catalogProductLinkTypeListV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-link-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/links/{type}/attributes": { - "get": { - "tags": [ - "catalogProductLinkTypeListV1" - ], - "description": "Provide a list of the product link type attributes", - "operationId": "catalogProductLinkTypeListV1GetItemAttributesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "type", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-link-attribute-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/links/{type}": { - "get": { - "tags": [ - "catalogProductLinkManagementV1" - ], - "description": "Provide the list of links for a specific product", - "operationId": "catalogProductLinkManagementV1GetLinkedItemsByTypeGet", - "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 - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-link-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/links": { - "post": { - "tags": [ - "catalogProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/links/{type}/{linkedProductSku}": { - "delete": { - "tags": [ - "catalogProductLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}/products": { - "get": { - "tags": [ - "catalogCategoryLinkManagementV1" - ], - "description": "Get products assigned to category", - "operationId": "catalogCategoryLinkManagementV1GetAssignedProductsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "categoryId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-category-product-link-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "catalogCategoryLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if assigned" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogCategoryLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if assigned" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/categories/{categoryId}/products/{sku}": { - "delete": { - "tags": [ - "catalogCategoryLinkRepositoryV1" - ], - "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": "string", - "required": true - }, - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if products successfully deleted" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/websites": { - "post": { - "tags": [ - "catalogProductWebsiteLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if website successfully assigned to product" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "catalogProductWebsiteLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if website successfully assigned to product" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/websites/{websiteId}": { - "delete": { - "tags": [ - "catalogProductWebsiteLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "will returned True if website successfully unassigned from product" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products-render-info": { - "get": { - "tags": [ - "catalogProductRenderListV1" - ], - "description": "Collect and retrieve the list of product render info This info contains raw prices and formated prices, product name, stock status, store_id, etc", - "operationId": "catalogProductRenderListV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": true - }, - { - "name": "currencyCode", - "in": "query", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-data-product-render-search-results-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}": { - "get": { - "tags": [ - "quoteCartRepositoryV1" - ], - "description": "Enables an administrative user to return information for a specified cart.", - "operationId": "quoteCartRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quoteCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/search": { - "get": { - "tags": [ - "quoteCartRepositoryV1" - ], - "description": "Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quoteCartRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine": { - "put": { - "tags": [ - "quoteCartRepositoryV1" - ], - "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" - } - } - } - }, - "post": { - "tags": [ - "quoteCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "new cart ID if customer did not have a cart or ID of the existing cart otherwise." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "quoteCartManagementV1" - ], - "description": "Returns information for the cart for a specified customer.", - "operationId": "quoteCartManagementV1GetCartForCustomerGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/": { - "post": { - "tags": [ - "quoteCartManagementV1" - ], - "description": "Creates an empty cart and quote for a guest.", - "operationId": "quoteCartManagementV1CreateEmptyCartPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Cart ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/customers/{customerId}/carts": { - "post": { - "tags": [ - "quoteCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "new cart ID if customer did not have a cart or ID of the existing cart otherwise." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/order": { - "put": { - "tags": [ - "quoteCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/order": { - "put": { - "tags": [ - "quoteCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}": { - "get": { - "tags": [ - "quoteGuestCartRepositoryV1" - ], - "description": "Enable a guest user to return information for a specified cart.", - "operationId": "quoteGuestCartRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quoteGuestCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts": { - "post": { - "tags": [ - "quoteGuestCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Cart ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/order": { - "put": { - "tags": [ - "quoteGuestCartManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/shipping-methods": { - "get": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "description": "Lists applicable shipping methods for a specified quote.", - "operationId": "quoteShippingMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/estimate-shipping-methods-by-address-id": { - "post": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/shipping-methods": { - "get": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "description": "Lists applicable shipping methods for a specified quote.", - "operationId": "quoteShippingMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/estimate-shipping-methods-by-address-id": { - "post": { - "tags": [ - "quoteShippingMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "quoteShipmentEstimationV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/estimate-shipping-methods": { - "post": { - "tags": [ - "quoteShipmentEstimationV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/shipping-methods": { - "get": { - "tags": [ - "quoteGuestShippingMethodManagementV1" - ], - "description": "List applicable shipping methods for a specified quote.", - "operationId": "quoteGuestShippingMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "quoteGuestShipmentEstimationV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/items": { - "get": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Lists items that are assigned to a specified cart.", - "operationId": "quoteCartItemRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of items.", - "items": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{quoteId}/items": { - "post": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/items/{itemId}": { - "put": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/items": { - "get": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "description": "Lists items that are assigned to a specified cart.", - "operationId": "quoteCartItemRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of items.", - "items": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/items/{itemId}": { - "put": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/items": { - "get": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "description": "List items that are assigned to a specified cart.", - "operationId": "quoteGuestCartItemRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of items.", - "items": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/items/{itemId}": { - "put": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-cart-item-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteGuestCartItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/selected-payment-method": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Returns the payment method for a specified shopping cart.", - "operationId": "quotePaymentMethodManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-payment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "redirect url or error message." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/payment-methods": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quotePaymentMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of payment methods.", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/selected-payment-method": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Returns the payment method for a specified shopping cart.", - "operationId": "quotePaymentMethodManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-payment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "redirect url or error message." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/payment-methods": { - "get": { - "tags": [ - "quotePaymentMethodManagementV1" - ], - "description": "Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quotePaymentMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of payment methods.", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/selected-payment-method": { - "get": { - "tags": [ - "quoteGuestPaymentMethodManagementV1" - ], - "description": "Return the payment method for a specified shopping cart.", - "operationId": "quoteGuestPaymentMethodManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-payment-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "quoteGuestPaymentMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Payment method ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/payment-methods": { - "get": { - "tags": [ - "quoteGuestPaymentMethodManagementV1" - ], - "description": "List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "quoteGuestPaymentMethodManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "Array of payment methods.", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/billing-address": { - "get": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "description": "Returns the billing address for a specified quote.", - "operationId": "quoteBillingAddressManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/billing-address": { - "get": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "description": "Returns the billing address for a specified quote.", - "operationId": "quoteBillingAddressManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteBillingAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/billing-address": { - "get": { - "tags": [ - "quoteGuestBillingAddressManagementV1" - ], - "description": "Return the billing address for a specified quote.", - "operationId": "quoteGuestBillingAddressManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "quoteGuestBillingAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/coupons": { - "get": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Returns information for a coupon in a specified cart.", - "operationId": "quoteCouponManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "The coupon code data." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/coupons/{couponCode}": { - "put": { - "tags": [ - "quoteCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/coupons": { - "get": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Returns information for a coupon in a specified cart.", - "operationId": "quoteCouponManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "The coupon code data." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteCouponManagementV1" - ], - "description": "Deletes a coupon from a specified cart.", - "operationId": "quoteCouponManagementV1RemoveDelete", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/coupons/{couponCode}": { - "put": { - "tags": [ - "quoteCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/coupons": { - "get": { - "tags": [ - "quoteGuestCouponManagementV1" - ], - "description": "Return information for a coupon in a specified cart.", - "operationId": "quoteGuestCouponManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "The coupon code data." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "quoteGuestCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/coupons/{couponCode}": { - "put": { - "tags": [ - "quoteGuestCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/totals": { - "get": { - "tags": [ - "quoteCartTotalRepositoryV1" - ], - "description": "Returns quote totals data for a specified cart.", - "operationId": "quoteCartTotalRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/totals": { - "get": { - "tags": [ - "quoteCartTotalRepositoryV1" - ], - "description": "Returns quote totals data for a specified cart.", - "operationId": "quoteCartTotalRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collect-totals": { - "put": { - "tags": [ - "quoteGuestCartTotalManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/totals": { - "get": { - "tags": [ - "quoteGuestCartTotalRepositoryV1" - ], - "description": "Return quote totals data for a specified cart.", - "operationId": "quoteGuestCartTotalRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collect-totals": { - "put": { - "tags": [ - "quoteCartTotalManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/links/{optionId}": { - "post": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/links/{id}": { - "put": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{productSku}/children": { - "get": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "description": "Get all children for Bundle product", - "operationId": "bundleProductLinkManagementV1GetChildrenGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "productSku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "optionId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/bundle-data-link-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}": { - "delete": { - "tags": [ - "bundleProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/options/all": { - "get": { - "tags": [ - "bundleProductOptionRepositoryV1" - ], - "description": "Get all options for bundle product", - "operationId": "bundleProductOptionRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/bundle-data-option-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/{sku}/options/{optionId}": { - "get": { - "tags": [ - "bundleProductOptionRepositoryV1" - ], - "description": "Get option for bundle product", - "operationId": "bundleProductOptionRepositoryV1GetGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/bundle-data-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "bundleProductOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/options/types": { - "get": { - "tags": [ - "bundleProductOptionTypeListV1" - ], - "description": "Get all types for options for bundle products", - "operationId": "bundleProductOptionTypeListV1GetItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/bundle-data-option-type-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/options/add": { - "post": { - "tags": [ - "bundleProductOptionManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bundle-products/options/{optionId}": { - "put": { - "tags": [ - "bundleProductOptionManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/requisition_lists": { - "post": { - "tags": [ - "requisitionListRequisitionListRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/requisition-list-data-requisition-list-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/search": { - "get": { - "tags": [ - "searchV1" - ], - "description": "Make Full Text Search and return found Documents", - "operationId": "searchV1SearchGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[requestName]", - "in": "query", - "type": "string" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/framework-search-search-result-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/stockItems/{productSku}": { - "get": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "description": "", - "operationId": "catalogInventoryStockRegistryV1GetStockItemBySkuGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "productSku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "scopeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{productSku}/stockItems/{itemId}": { - "put": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/stockItems/lowStock/": { - "get": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "description": "Retrieves a list of SKU's with low inventory qty", - "operationId": "catalogInventoryStockRegistryV1GetLowStockItemsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "scopeId", - "in": "query", - "type": "integer", - "required": true - }, - { - "name": "qty", - "in": "query", - "type": "number", - "required": true - }, - { - "name": "currentPage", - "in": "query", - "type": "integer", - "required": false - }, - { - "name": "pageSize", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-collection-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/stockStatuses/{productSku}": { - "get": { - "tags": [ - "catalogInventoryStockRegistryV1" - ], - "description": "", - "operationId": "catalogInventoryStockRegistryV1GetStockStatusBySkuGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "productSku", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "scopeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/catalog-inventory-data-stock-status-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}": { - "get": { - "tags": [ - "salesOrderRepositoryV1" - ], - "description": "Loads a specified order.", - "operationId": "salesOrderRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders": { - "get": { - "tags": [ - "salesOrderRepositoryV1" - ], - "description": "Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesOrderRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/create": { - "put": { - "tags": [ - "salesOrderRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/": { - "post": { - "tags": [ - "salesOrderRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/statuses": { - "get": { - "tags": [ - "salesOrderManagementV1" - ], - "description": "Gets the status for a specified order.", - "operationId": "salesOrderManagementV1GetStatusGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Order status." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/cancel": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/emails": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/hold": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/unhold": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{id}/comments": { - "post": { - "tags": [ - "salesOrderManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "salesOrderManagementV1" - ], - "description": "Lists comments for a specified order.", - "operationId": "salesOrderManagementV1GetCommentsListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-status-history-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/{parent_id}": { - "put": { - "tags": [ - "salesOrderAddressRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/items/{id}": { - "get": { - "tags": [ - "salesOrderItemRepositoryV1" - ], - "description": "Loads a specified order item.", - "operationId": "salesOrderItemRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The order item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-item-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/orders/items": { - "get": { - "tags": [ - "salesOrderItemRepositoryV1" - ], - "description": "Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesOrderItemRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-order-item-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}": { - "get": { - "tags": [ - "salesInvoiceRepositoryV1" - ], - "description": "Loads a specified invoice.", - "operationId": "salesInvoiceRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The invoice ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices": { - "get": { - "tags": [ - "salesInvoiceRepositoryV1" - ], - "description": "Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesInvoiceRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/": { - "post": { - "tags": [ - "salesInvoiceRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/comments": { - "get": { - "tags": [ - "salesInvoiceManagementV1" - ], - "description": "Lists comments for a specified invoice.", - "operationId": "salesInvoiceManagementV1GetCommentsListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The invoice ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/emails": { - "post": { - "tags": [ - "salesInvoiceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/void": { - "post": { - "tags": [ - "salesInvoiceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/{id}/capture": { - "post": { - "tags": [ - "salesInvoiceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoices/comments": { - "post": { - "tags": [ - "salesInvoiceCommentRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-invoice-comment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/invoice/{invoiceId}/refund": { - "post": { - "tags": [ - "salesRefundInvoiceV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/{id}/comments": { - "get": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "description": "Lists comments for a specified credit memo.", - "operationId": "salesCreditmemoManagementV1GetCommentsListGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "salesCreditmemoCommentRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-comment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/{id}": { - "put": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "salesCreditmemoRepositoryV1" - ], - "description": "Loads a specified credit memo.", - "operationId": "salesCreditmemoRepositoryV1GetGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/{id}/emails": { - "post": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo/refund": { - "post": { - "tags": [ - "salesCreditmemoManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemos": { - "get": { - "tags": [ - "salesCreditmemoRepositoryV1" - ], - "description": "Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesCreditmemoRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/creditmemo": { - "post": { - "tags": [ - "salesCreditmemoRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/order/{orderId}/refund": { - "post": { - "tags": [ - "salesRefundOrderV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}": { - "get": { - "tags": [ - "salesShipmentRepositoryV1" - ], - "description": "Loads a specified shipment.", - "operationId": "salesShipmentRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The shipment ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipments": { - "get": { - "tags": [ - "salesShipmentRepositoryV1" - ], - "description": "Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesShipmentRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/": { - "post": { - "tags": [ - "salesShipmentRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}/comments": { - "get": { - "tags": [ - "salesShipmentManagementV1" - ], - "description": "Lists comments for a specified shipment.", - "operationId": "salesShipmentManagementV1GetCommentsListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The shipment ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "salesShipmentCommentRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-comment-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}/emails": { - "post": { - "tags": [ - "salesShipmentManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/{id}/label": { - "get": { - "tags": [ - "salesShipmentManagementV1" - ], - "description": "Gets a specified shipment label.", - "operationId": "salesShipmentManagementV1GetLabelGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The shipment label ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Shipment label." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/track": { - "post": { - "tags": [ - "salesShipmentTrackRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-shipment-track-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/shipment/track/{id}": { - "delete": { - "tags": [ - "salesShipmentTrackRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/order/{orderId}/ship": { - "post": { - "tags": [ - "salesShipOrderV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Id of created Shipment." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/transactions/{id}": { - "get": { - "tags": [ - "salesTransactionRepositoryV1" - ], - "description": "Loads a specified transaction.", - "operationId": "salesTransactionRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true, - "description": "The transaction ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-transaction-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/transactions": { - "get": { - "tags": [ - "salesTransactionRepositoryV1" - ], - "description": "Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesTransactionRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-data-transaction-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/order/{orderId}/invoice": { - "post": { - "tags": [ - "salesInvoiceOrderV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/shipping-information": { - "post": { - "tags": [ - "checkoutGuestShippingInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/shipping-information": { - "post": { - "tags": [ - "checkoutShippingInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/shipping-information": { - "post": { - "tags": [ - "checkoutShippingInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/totals-information": { - "post": { - "tags": [ - "checkoutTotalsInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/totals-information": { - "post": { - "tags": [ - "checkoutTotalsInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/totals-information": { - "post": { - "tags": [ - "checkoutGuestTotalsInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/payment-information": { - "post": { - "tags": [ - "checkoutGuestPaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "checkoutGuestPaymentInformationManagementV1" - ], - "description": "Get payment information", - "operationId": "checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/set-payment-information": { - "post": { - "tags": [ - "checkoutGuestPaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/payment-information": { - "post": { - "tags": [ - "checkoutPaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "checkoutPaymentInformationManagementV1" - ], - "description": "Get payment information", - "operationId": "checkoutPaymentInformationManagementV1GetPaymentInformationGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/set-payment-information": { - "post": { - "tags": [ - "checkoutPaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/salesRules/{ruleId}": { - "get": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "description": "Get rule by ID.", - "operationId": "salesRuleRuleRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "ruleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/salesRules/search": { - "get": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "description": "Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesRuleRuleRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/salesRules": { - "post": { - "tags": [ - "salesRuleRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/{couponId}": { - "get": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "description": "Get coupon by coupon id.", - "operationId": "salesRuleCouponRepositoryV1GetByIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "couponId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/search": { - "get": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "description": "Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "salesRuleCouponRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons": { - "post": { - "tags": [ - "salesRuleCouponRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/generate": { - "post": { - "tags": [ - "salesRuleCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/deleteByIds": { - "post": { - "tags": [ - "salesRuleCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/coupons/deleteByCodes": { - "post": { - "tags": [ - "salesRuleCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/sales-rule-data-coupon-mass-delete-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/children": { - "get": { - "tags": [ - "configurableProductLinkManagementV1" - ], - "description": "Get all children for Configurable product", - "operationId": "configurableProductLinkManagementV1GetChildrenGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/children/{childSku}": { - "delete": { - "tags": [ - "configurableProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/child": { - "post": { - "tags": [ - "configurableProductLinkManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/variation": { - "put": { - "tags": [ - "configurableProductConfigurableProductManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-product-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/options/{id}": { - "get": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "description": "Get option for configurable product", - "operationId": "configurableProductOptionRepositoryV1GetGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/configurable-product-data-option-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/options/all": { - "get": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "description": "Get all options for configurable product", - "operationId": "configurableProductOptionRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/configurable-product-data-option-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/configurable-products/{sku}/options": { - "post": { - "tags": [ - "configurableProductOptionRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links": { - "get": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "description": "List of links with associated samples", - "operationId": "downloadableLinkRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/downloadable-data-link-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links/{id}": { - "put": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/downloadable-links/{id}": { - "delete": { - "tags": [ - "downloadableLinkRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links/samples": { - "get": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "description": "List of samples for downloadable product", - "operationId": "downloadableSampleRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sku", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/downloadable-data-sample-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/{sku}/downloadable-links/samples/{id}": { - "put": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/products/downloadable-links/samples/{id}": { - "delete": { - "tags": [ - "downloadableSampleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/licence": { - "get": { - "tags": [ - "checkoutAgreementsCheckoutAgreementsRepositoryV1" - ], - "description": "Lists active checkout agreements.", - "operationId": "checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/checkout-agreements-data-agreement-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRates": { - "post": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRates/{rateId}": { - "get": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "description": "Get tax rate", - "operationId": "taxTaxRateRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "rateId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRates/search": { - "get": { - "tags": [ - "taxTaxRateRepositoryV1" - ], - "description": "Search TaxRates This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "taxTaxRateRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rate-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRules": { - "post": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRules/{ruleId}": { - "delete": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "description": "Get TaxRule", - "operationId": "taxTaxRuleRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "ruleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxRules/search": { - "get": { - "tags": [ - "taxTaxRuleRepositoryV1" - ], - "description": "Search TaxRules This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "taxTaxRuleRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-rule-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses": { - "post": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "id for the newly created Tax class" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses/{taxClassId}": { - "get": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "description": "Get a tax class with the given tax class id.", - "operationId": "taxTaxClassRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "taxClassId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-class-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "True if the tax class was deleted, false otherwise" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses/{classId}": { - "put": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "id for the newly created Tax class" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/taxClasses/search": { - "get": { - "tags": [ - "taxTaxClassRepositoryV1" - ], - "description": "Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.", - "operationId": "taxTaxClassRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/tax-data-tax-class-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/": { - "get": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "description": "Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included.", - "operationId": "companyCompanyRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/{companyId}": { - "get": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "description": "Returns company details.", - "operationId": "companyCompanyRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "companyId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "companyCompanyRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/team/": { - "get": { - "tags": [ - "companyTeamRepositoryV1" - ], - "description": "Returns the list of teams for the specified search criteria (team name or description).", - "operationId": "companyTeamRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-team-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/team/{teamId}": { - "get": { - "tags": [ - "companyTeamRepositoryV1" - ], - "description": "Returns data for a team in the company, by entity id.", - "operationId": "companyTeamRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "teamId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-team-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "companyTeamRepositoryV1" - ], - "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": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "companyTeamRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/team/{companyId}": { - "post": { - "tags": [ - "companyTeamRepositoryV1" - ], - "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": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/hierarchy/{id}": { - "get": { - "tags": [ - "companyCompanyHierarchyV1" - ], - "description": "Returns the list of teams and company users in the company structure.", - "operationId": "companyCompanyHierarchyV1GetCompanyHierarchyGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/company-data-hierarchy-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/hierarchy/move/{id}": { - "put": { - "tags": [ - "companyCompanyHierarchyV1" - ], - "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" - } - } - } - } - }, - "/V1/company/role/": { - "get": { - "tags": [ - "companyRoleRepositoryV1" - ], - "description": "Returns the list of roles and permissions for a specified company.", - "operationId": "companyRoleRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "companyRoleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/role/{roleId}": { - "get": { - "tags": [ - "companyRoleRepositoryV1" - ], - "description": "Returns the list of permissions for a specified role.", - "operationId": "companyRoleRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "roleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "companyRoleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/role/{id}": { - "put": { - "tags": [ - "companyRoleRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/assignRoles": { - "put": { - "tags": [ - "companyAclV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/company/role/{roleId}/users": { - "get": { - "tags": [ - "companyAclV1" - ], - "description": "View the list of company users assigned to a specified role.", - "operationId": "companyAclV1GetUsersByRoleIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "roleId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-customer-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/integration/admin/token": { - "post": { - "tags": [ - "integrationAdminTokenServiceV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Token created" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/integration/customer/token": { - "post": { - "tags": [ - "integrationCustomerTokenServiceV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string", - "description": "Token created" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/analytics/link": { - "get": { - "tags": [ - "analyticsLinkProviderV1" - ], - "description": "", - "operationId": "analyticsLinkProviderV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/analytics-data-link-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/balance/apply": { - "post": { - "tags": [ - "customerBalanceBalanceManagementFromQuoteV1" - ], - "description": "Apply store credit.", - "operationId": "customerBalanceBalanceManagementFromQuoteV1ApplyPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/balance/unapply": { - "post": { - "tags": [ - "customerBalanceBalanceManagementFromQuoteV1" - ], - "description": "Unapply store credit.", - "operationId": "customerBalanceBalanceManagementFromQuoteV1UnapplyPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/request": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuoteManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/submitToCustomer": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuoteManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/decline": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuoteManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/pricesUpdated": { - "post": { - "tags": [ - "negotiableQuoteNegotiableQuotePriceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/attachmentContent": { - "get": { - "tags": [ - "negotiableQuoteAttachmentContentManagementV1" - ], - "description": "Returns content for one or more files attached on the quote comment.", - "operationId": "negotiableQuoteAttachmentContentManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attachmentIds", - "in": "query", - "type": "array", - "items": { - "type": "integer" - }, - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/negotiable-quote-data-attachment-content-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/{quoteId}/comments": { - "get": { - "tags": [ - "negotiableQuoteCommentLocatorV1" - ], - "description": "Returns comments for a specified negotiable quote.", - "operationId": "negotiableQuoteCommentLocatorV1GetListForQuoteGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "quoteId", - "in": "path", - "type": "integer", - "required": true, - "description": "Negotiable Quote ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of quote comments.", - "items": { - "$ref": "#/definitions/negotiable-quote-data-comment-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/{quoteId}/shippingMethod": { - "put": { - "tags": [ - "negotiableQuoteNegotiableQuoteShippingManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/payment-information": { - "post": { - "tags": [ - "negotiableQuotePaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "negotiableQuotePaymentInformationManagementV1" - ], - "description": "Get payment information", - "operationId": "negotiableQuotePaymentInformationManagementV1GetPaymentInformationGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/set-payment-information": { - "post": { - "tags": [ - "negotiableQuotePaymentInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/shipping-information": { - "post": { - "tags": [ - "negotiableQuoteShippingInformationManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/checkout-data-payment-details-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "negotiableQuoteShipmentEstimationV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id": { - "post": { - "tags": [ - "negotiableQuoteShippingMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiableQuote/{quoteId}": { - "put": { - "tags": [ - "negotiableQuoteNegotiableCartRepositoryV1" - ], - "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" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/billing-address": { - "get": { - "tags": [ - "negotiableQuoteBillingAddressManagementV1" - ], - "description": "Returns the billing address for a specified quote.", - "operationId": "negotiableQuoteBillingAddressManagementV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-address-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "negotiableQuoteBillingAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Address ID." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/totals": { - "get": { - "tags": [ - "negotiableQuoteCartTotalRepositoryV1" - ], - "description": "Returns quote totals data for a specified cart.", - "operationId": "negotiableQuoteCartTotalRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/quote-data-totals-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/coupons/{couponCode}": { - "put": { - "tags": [ - "negotiableQuoteCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/coupons": { - "delete": { - "tags": [ - "negotiableQuoteCouponManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/giftCards": { - "post": { - "tags": [ - "negotiableQuoteGiftCardAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "negotiableQuoteGiftCardAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{quoteId}/giftCards": { - "get": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "Return GiftCard Account cards", - "operationId": "giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "quoteId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-card-account-data-gift-card-account-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/giftCards": { - "put": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/giftCards": { - "post": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/checkGiftCard/{giftCardCode}": { - "get": { - "tags": [ - "giftCardAccountGiftCardAccountManagementV1" - ], - "description": "", - "operationId": "giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "giftCardCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "number" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}": { - "delete": { - "tags": [ - "giftCardAccountGuestGiftCardAccountManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/guest-carts/{cartId}/giftCards": { - "post": { - "tags": [ - "giftCardAccountGuestGiftCardAccountManagementV1" - ], - "description": "", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}": { - "get": { - "tags": [ - "giftCardAccountGuestGiftCardAccountManagementV1" - ], - "description": "", - "operationId": "giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet", - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "number" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}": { - "get": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "description": "Return the following properties for the selected shared catalog: ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.", - "operationId": "sharedCatalogSharedCatalogRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sharedCatalogId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog": { - "post": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}": { - "put": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/": { - "get": { - "tags": [ - "sharedCatalogSharedCatalogRepositoryV1" - ], - "description": "Return the list of shared catalogs and basic properties for each catalog.", - "operationId": "sharedCatalogSharedCatalogRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/shared-catalog-data-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}/companies": { - "get": { - "tags": [ - "sharedCatalogCompanyManagementV1" - ], - "description": "Return the list of company IDs for the companies assigned to the selected catalog.", - "operationId": "sharedCatalogCompanyManagementV1GetCompaniesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "sharedCatalogId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}/assignCompanies": { - "post": { - "tags": [ - "sharedCatalogCompanyManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{sharedCatalogId}/unassignCompanies": { - "post": { - "tags": [ - "sharedCatalogCompanyManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/products": { - "get": { - "tags": [ - "sharedCatalogProductManagementV1" - ], - "description": "Return the list of product SKUs in the selected shared catalog.", - "operationId": "sharedCatalogProductManagementV1GetProductsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/assignProducts": { - "post": { - "tags": [ - "sharedCatalogProductManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/unassignProducts": { - "post": { - "tags": [ - "sharedCatalogProductManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/categories": { - "get": { - "tags": [ - "sharedCatalogCategoryManagementV1" - ], - "description": "Return the list of categories in the selected shared catalog.", - "operationId": "sharedCatalogCategoryManagementV1GetCategoriesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "type": "integer" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/assignCategories": { - "post": { - "tags": [ - "sharedCatalogCategoryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/sharedCatalog/{id}/unassignCategories": { - "post": { - "tags": [ - "sharedCatalogCategoryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/gift-message": { - "get": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "description": "Return the gift message for a specified order.", - "operationId": "giftMessageCartRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "integer", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/gift-message": { - "get": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "description": "Return the gift message for a specified order.", - "operationId": "giftMessageCartRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageCartRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/{cartId}/gift-message/{itemId}": { - "get": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "description": "Return the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageItemRepositoryV1GetGet", - "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": "itemId", - "in": "path", - "type": "integer", - "required": true, - "description": "The item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/gift-message/{itemId}": { - "get": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "description": "Return the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageItemRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "itemId", - "in": "path", - "type": "integer", - "required": true, - "description": "The item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/gift-message": { - "get": { - "tags": [ - "giftMessageGuestCartRepositoryV1" - ], - "description": "Return the gift message for a specified order.", - "operationId": "giftMessageGuestCartRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true, - "description": "The shopping cart ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageGuestCartRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/gift-message/{itemId}": { - "get": { - "tags": [ - "giftMessageGuestItemRepositoryV1" - ], - "description": "Return the gift message for a specified item in a specified shopping cart.", - "operationId": "giftMessageGuestItemRepositoryV1GetGet", - "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": "itemId", - "in": "path", - "type": "integer", - "required": true, - "description": "The item ID." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-message-data-message-interface" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "tags": [ - "giftMessageGuestItemRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/giftregistry/mine/estimate-shipping-methods": { - "post": { - "tags": [ - "giftRegistryShippingMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-giftregistry/{cartId}/estimate-shipping-methods": { - "post": { - "tags": [ - "giftRegistryGuestCartShippingMethodManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "description": "An array of shipping methods.", - "items": { - "$ref": "#/definitions/quote-data-shipping-method-interface" - } - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/gift-wrappings/{id}": { - "get": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "description": "Return data object for specified wrapping ID and store.", - "operationId": "giftWrappingWrappingRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "storeId", - "in": "query", - "type": "integer", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/gift-wrappings": { - "post": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "description": "Return list of gift wrapping data objects based on search criteria", - "operationId": "giftWrappingWrappingRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/gift-wrappings/{wrappingId}": { - "put": { - "tags": [ - "giftWrappingWrappingRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/reward/mine/use-reward": { - "post": { - "tags": [ - "rewardRewardManagementV1" - ], - "description": "Set reward points to quote", - "operationId": "rewardRewardManagementV1SetPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/tracking-numbers": { - "post": { - "tags": [ - "rmaTrackManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "rmaTrackManagementV1" - ], - "description": "Get track list", - "operationId": "rmaTrackManagementV1GetTracksGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-track-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/tracking-numbers/{trackId}": { - "delete": { - "tags": [ - "rmaTrackManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/labels": { - "get": { - "tags": [ - "rmaTrackManagementV1" - ], - "description": "Get shipping label int the PDF format", - "operationId": "rmaTrackManagementV1GetShippingLabelPdfGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}": { - "get": { - "tags": [ - "rmaRmaRepositoryV1" - ], - "description": "Return data object for specified RMA id", - "operationId": "rmaRmaRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "rmaRmaRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "put": { - "tags": [ - "rmaRmaManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns/{id}/comments": { - "post": { - "tags": [ - "rmaCommentManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "rmaCommentManagementV1" - ], - "description": "Comments list", - "operationId": "rmaCommentManagementV1CommentsListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "id", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-comment-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returns": { - "post": { - "tags": [ - "rmaRmaManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "get": { - "tags": [ - "rmaRmaManagementV1" - ], - "description": "Return list of rma data objects based on search criteria", - "operationId": "rmaRmaManagementV1SearchGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/rma-data-rma-search-result-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata/{attributeCode}": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Retrieve attribute metadata.", - "operationId": "rmaRmaAttributesManagementV1GetAttributeMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "attributeCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata/form/{formCode}": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Retrieve all attributes filtered by form code", - "operationId": "rmaRmaAttributesManagementV1GetAttributesGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "formCode", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Get all attribute metadata.", - "operationId": "rmaRmaAttributesManagementV1GetAllAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/customer-data-attribute-metadata-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/returnsAttributeMetadata/custom": { - "get": { - "tags": [ - "rmaRmaAttributesManagementV1" - ], - "description": "Get custom attribute metadata for the given Data object's attribute set", - "operationId": "rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "dataObjectClassName", - "in": "query", - "type": "string", - "description": "Data object class name", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-metadata-object-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/": { - "get": { - "tags": [ - "companyCreditCreditLimitRepositoryV1" - ], - "description": "Returns the list of credits for specified companies.", - "operationId": "companyCreditCreditLimitRepositoryV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{creditId}": { - "get": { - "tags": [ - "companyCreditCreditLimitRepositoryV1" - ], - "description": "Returns data on the credit limit for a specified credit limit ID.", - "operationId": "companyCreditCreditLimitRepositoryV1GetGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "creditId", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "reload", - "in": "query", - "type": "boolean", - "description": "[optional]", - "required": false - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{id}": { - "put": { - "tags": [ - "companyCreditCreditLimitRepositoryV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/company/{companyId}": { - "get": { - "tags": [ - "companyCreditCreditLimitManagementV1" - ], - "description": "Returns data on the credit limit for a specified company.", - "operationId": "companyCreditCreditLimitManagementV1GetCreditByCompanyIdGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "companyId", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-credit-limit-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{creditId}/increaseBalance": { - "post": { - "tags": [ - "companyCreditCreditBalanceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/{creditId}/decreaseBalance": { - "post": { - "tags": [ - "companyCreditCreditBalanceManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/history": { - "get": { - "tags": [ - "companyCreditCreditHistoryManagementV1" - ], - "description": "Returns the credit history for one or more companies.", - "operationId": "companyCreditCreditHistoryManagementV1GetListGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "searchCriteria[filterGroups][0][filters][0][field]", - "in": "query", - "type": "string", - "description": "Field" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][value]", - "in": "query", - "type": "string", - "description": "Value" - }, - { - "name": "searchCriteria[filterGroups][0][filters][0][conditionType]", - "in": "query", - "type": "string", - "description": "Condition type" - }, - { - "name": "searchCriteria[sortOrders][0][field]", - "in": "query", - "type": "string", - "description": "Sorting field." - }, - { - "name": "searchCriteria[sortOrders][0][direction]", - "in": "query", - "type": "string", - "description": "Sorting direction." - }, - { - "name": "searchCriteria[pageSize]", - "in": "query", - "type": "integer", - "description": "Page size." - }, - { - "name": "searchCriteria[currentPage]", - "in": "query", - "type": "integer", - "description": "Current page." - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/company-credit-data-history-search-results-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/companyCredits/history/{historyId}": { - "put": { - "tags": [ - "companyCreditCreditHistoryManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean", - "description": "true on success" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bulk/{bulkUuid}/detailed-status": { - "get": { - "tags": [ - "asynchronousOperationsBulkStatusV1" - ], - "description": "Get Bulk summary data with list of operations items full data.", - "operationId": "asynchronousOperationsBulkStatusV1GetBulkDetailedStatusGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "bulkUuid", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/asynchronous-operations-data-detailed-bulk-operations-status-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bulk/{bulkUuid}/status": { - "get": { - "tags": [ - "asynchronousOperationsBulkStatusV1" - ], - "description": "Get Bulk summary data with list of operations items short data.", - "operationId": "asynchronousOperationsBulkStatusV1GetBulkShortStatusGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "bulkUuid", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/asynchronous-operations-data-bulk-operations-status-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/bulk/{bulkUuid}/operation-status/{status}": { - "get": { - "tags": [ - "asynchronousOperationsBulkStatusV1" - ], - "description": "Get operations count by bulk uuid and status.", - "operationId": "asynchronousOperationsBulkStatusV1GetOperationsCountByBulkIdAndStatusGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "bulkUuid", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "status", - "in": "path", - "type": "integer", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/worldpay-guest-carts/{cartId}/payment-information": { - "post": { - "tags": [ - "worldpayGuestPaymentInformationManagementProxyV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Order ID." - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/amazon-shipping-address/{amazonOrderReferenceId}": { - "put": { - "tags": [ - "amazonPaymentAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/amazon-billing-address/{amazonOrderReferenceId}": { - "put": { - "tags": [ - "amazonPaymentAddressManagementV1" - ], - "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": { - "200": { - "description": "200 Success.", - "schema": { - "type": "string" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/amazon/order-ref": { - "delete": { - "tags": [ - "amazonPaymentOrderInformationManagementV1" - ], - "description": "", - "operationId": "amazonPaymentOrderInformationManagementV1RemoveOrderReferenceDelete", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/delivery-option": { - "post": { - "tags": [ - "temandoShippingQuoteCartDeliveryOptionManagementV1" - ], - "description": "Handle selected delivery option.", - "operationId": "temandoShippingQuoteCartDeliveryOptionManagementV1SavePost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "temandoShippingQuoteCartDeliveryOptionManagementV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "selectedOption" - ], - "properties": { - "selectedOption": { - "type": "string" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/delivery-option": { - "post": { - "tags": [ - "temandoShippingQuoteGuestCartDeliveryOptionManagementV1" - ], - "description": "Handle selected delivery option.", - "operationId": "temandoShippingQuoteGuestCartDeliveryOptionManagementV1SavePost", - "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": "temandoShippingQuoteGuestCartDeliveryOptionManagementV1SavePostBody", - "in": "body", - "schema": { - "required": [ - "selectedOption" - ], - "properties": { - "selectedOption": { - "type": "string" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/temando/rma/{rmaId}/shipments": { - "put": { - "tags": [ - "temandoShippingRmaRmaShipmentManagementV1" - ], - "description": "Assign platform shipment IDs to a core RMA entity.", - "operationId": "temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPut", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "rmaId", - "in": "path", - "type": "integer", - "required": true - }, - { - "name": "temandoShippingRmaRmaShipmentManagementV1AssignShipmentIdsPutBody", - "in": "body", - "schema": { - "required": [ - "returnShipmentIds" - ], - "properties": { - "returnShipmentIds": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "integer", - "description": "Number of successfully assigned shipment IDs." - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collection-point/search-request": { - "put": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SaveSearchRequestPut", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SaveSearchRequestPutBody", - "in": "body", - "schema": { - "required": [ - "countryId", - "postcode" - ], - "properties": { - "countryId": { - "type": "string" - }, - "postcode": { - "type": "string" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/temando-shipping-data-collection-point-search-request-interface" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1DeleteSearchRequestDelete", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collection-point/search-result": { - "get": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1GetCollectionPointsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/temando-shipping-data-collection-point-quote-collection-point-interface" - } - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/collection-point/select": { - "post": { - "tags": [ - "temandoShippingCollectionPointGuestCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SelectCollectionPointPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "temandoShippingCollectionPointGuestCartCollectionPointManagementV1SelectCollectionPointPostBody", - "in": "body", - "schema": { - "required": [ - "entityId" - ], - "properties": { - "entityId": { - "type": "integer" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collection-point/search-request": { - "put": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1SaveSearchRequestPut", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "temandoShippingCollectionPointCartCollectionPointManagementV1SaveSearchRequestPutBody", - "in": "body", - "schema": { - "required": [ - "countryId", - "postcode" - ], - "properties": { - "countryId": { - "type": "string" - }, - "postcode": { - "type": "string" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "$ref": "#/definitions/temando-shipping-data-collection-point-search-request-interface" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "delete": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1DeleteSearchRequestDelete", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collection-point/search-result": { - "get": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1GetCollectionPointsGet", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "array", - "items": { - "$ref": "#/definitions/temando-shipping-data-collection-point-quote-collection-point-interface" - } - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/collection-point/select": { - "post": { - "tags": [ - "temandoShippingCollectionPointCartCollectionPointManagementV1" - ], - "description": "", - "operationId": "temandoShippingCollectionPointCartCollectionPointManagementV1SelectCollectionPointPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "temandoShippingCollectionPointCartCollectionPointManagementV1SelectCollectionPointPostBody", - "in": "body", - "schema": { - "required": [ - "entityId" - ], - "properties": { - "entityId": { - "type": "integer" - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "200": { - "description": "200 Success.", - "schema": { - "type": "boolean" - } - }, - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "500": { - "description": "Internal Server error", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/guest-carts/{cartId}/checkout-fields": { - "post": { - "tags": [ - "temandoShippingQuoteGuestCartCheckoutFieldManagementV1" - ], - "description": "", - "operationId": "temandoShippingQuoteGuestCartCheckoutFieldManagementV1SaveCheckoutFieldsPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "cartId", - "in": "path", - "type": "string", - "required": true - }, - { - "name": "temandoShippingQuoteGuestCartCheckoutFieldManagementV1SaveCheckoutFieldsPostBody", - "in": "body", - "schema": { - "required": [ - "serviceSelection" - ], - "properties": { - "serviceSelection": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - }, - "/V1/carts/mine/checkout-fields": { - "post": { - "tags": [ - "temandoShippingQuoteCartCheckoutFieldManagementV1" - ], - "description": "", - "operationId": "temandoShippingQuoteCartCheckoutFieldManagementV1SaveCheckoutFieldsPost", - "consumes": [ - "application/json", - "application/xml" - ], - "produces": [ - "application/json", - "application/xml" - ], - "parameters": [ - { - "name": "temandoShippingQuoteCartCheckoutFieldManagementV1SaveCheckoutFieldsPostBody", - "in": "body", - "schema": { - "required": [ - "serviceSelection" - ], - "properties": { - "serviceSelection": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - }, - "type": "object", - "xml": { - "name": "request" - } - } - } - ], - "responses": { - "401": { - "description": "401 Unauthorized", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "400": { - "description": "400 Bad Request", - "schema": { - "$ref": "#/definitions/error-response" - } - }, - "default": { - "description": "Unexpected error", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - } - } - }, - "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" - } - } - }, - "store-data-store-interface": { - "type": "object", - "description": "Store interface", - "properties": { - "id": { - "type": "integer" - }, - "code": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Store name" - }, - "website_id": { - "type": "integer" - }, - "store_group_id": { - "type": "integer" - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-store-extension-interface" - } - }, - "required": [ - "id", - "code", - "name", - "website_id", - "store_group_id" - ] - }, - "store-data-store-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface" - }, - "store-data-group-interface": { - "type": "object", - "description": "Group interface", - "properties": { - "id": { - "type": "integer" - }, - "website_id": { - "type": "integer" - }, - "root_category_id": { - "type": "integer" - }, - "default_store_id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "code": { - "type": "string", - "description": "Group code." - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-group-extension-interface" - } - }, - "required": [ - "id", - "website_id", - "root_category_id", - "default_store_id", - "name", - "code" - ] - }, - "store-data-group-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface" - }, - "store-data-website-interface": { - "type": "object", - "description": "Website interface", - "properties": { - "id": { - "type": "integer" - }, - "code": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Website name" - }, - "default_group_id": { - "type": "integer" - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-website-extension-interface" - } - }, - "required": [ - "id", - "code", - "name", - "default_group_id" - ] - }, - "store-data-website-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface" - }, - "store-data-store-config-interface": { - "type": "object", - "description": "StoreConfig interface", - "properties": { - "id": { - "type": "integer", - "description": "Store id" - }, - "code": { - "type": "string", - "description": "Store code" - }, - "website_id": { - "type": "integer", - "description": "Website id of the store" - }, - "locale": { - "type": "string", - "description": "Store locale" - }, - "base_currency_code": { - "type": "string", - "description": "Base currency code" - }, - "default_display_currency_code": { - "type": "string", - "description": "Default display currency code" - }, - "timezone": { - "type": "string", - "description": "Timezone of the store" - }, - "weight_unit": { - "type": "string", - "description": "The unit of weight" - }, - "base_url": { - "type": "string", - "description": "Base URL for the store" - }, - "base_link_url": { - "type": "string", - "description": "Base link URL for the store" - }, - "base_static_url": { - "type": "string", - "description": "Base static URL for the store" - }, - "base_media_url": { - "type": "string", - "description": "Base media URL for the store" - }, - "secure_base_url": { - "type": "string", - "description": "Secure base URL for the store" - }, - "secure_base_link_url": { - "type": "string", - "description": "Secure base link URL for the store" - }, - "secure_base_static_url": { - "type": "string", - "description": "Secure base static URL for the store" - }, - "secure_base_media_url": { - "type": "string", - "description": "Secure base media URL for the store" - }, - "extension_attributes": { - "$ref": "#/definitions/store-data-store-config-extension-interface" - } - }, - "required": [ - "id", - "code", - "website_id", - "locale", - "base_currency_code", - "default_display_currency_code", - "timezone", - "weight_unit", - "base_url", - "base_link_url", - "base_static_url", - "base_media_url", - "secure_base_url", - "secure_base_link_url", - "secure_base_static_url", - "secure_base_media_url" - ] - }, - "store-data-store-config-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface" - }, - "directory-data-currency-information-interface": { - "type": "object", - "description": "Currency Information interface.", - "properties": { - "base_currency_code": { - "type": "string", - "description": "The base currency code for the store." - }, - "base_currency_symbol": { - "type": "string", - "description": "The currency symbol of the base currency for the store." - }, - "default_display_currency_code": { - "type": "string", - "description": "The default display currency code for the store." - }, - "default_display_currency_symbol": { - "type": "string", - "description": "The currency symbol of the default display currency for the store." - }, - "available_currency_codes": { - "type": "array", - "description": "The list of allowed currency codes for the store.", - "items": { - "type": "string" - } - }, - "exchange_rates": { - "type": "array", - "description": "The list of exchange rate information for the store.", - "items": { - "$ref": "#/definitions/directory-data-exchange-rate-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-currency-information-extension-interface" - } - }, - "required": [ - "base_currency_code", - "base_currency_symbol", - "default_display_currency_code", - "default_display_currency_symbol", - "available_currency_codes", - "exchange_rates" - ] - }, - "directory-data-exchange-rate-interface": { - "type": "object", - "description": "Exchange Rate interface.", - "properties": { - "currency_to": { - "type": "string", - "description": "The currency code associated with the exchange rate." - }, - "rate": { - "type": "number", - "description": "The exchange rate for the associated currency and the store's base currency." - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-exchange-rate-extension-interface" - } - }, - "required": [ - "currency_to", - "rate" - ] - }, - "directory-data-exchange-rate-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface" - }, - "directory-data-currency-information-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface" - }, - "directory-data-country-information-interface": { - "type": "object", - "description": "Country Information interface.", - "properties": { - "id": { - "type": "string", - "description": "The country id for the store." - }, - "two_letter_abbreviation": { - "type": "string", - "description": "The country 2 letter abbreviation for the store." - }, - "three_letter_abbreviation": { - "type": "string", - "description": "The country 3 letter abbreviation for the store." - }, - "full_name_locale": { - "type": "string", - "description": "The country full name (in store locale) for the store." - }, - "full_name_english": { - "type": "string", - "description": "The country full name (in English) for the store." - }, - "available_regions": { - "type": "array", - "description": "The available regions for the store.", - "items": { - "$ref": "#/definitions/directory-data-region-information-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-country-information-extension-interface" - } - }, - "required": [ - "id", - "two_letter_abbreviation", - "three_letter_abbreviation", - "full_name_locale", - "full_name_english" - ] - }, - "directory-data-region-information-interface": { - "type": "object", - "description": "Region Information interface.", - "properties": { - "id": { - "type": "string", - "description": "Region id" - }, - "code": { - "type": "string", - "description": "Region code" - }, - "name": { - "type": "string", - "description": "Region name" - }, - "extension_attributes": { - "$ref": "#/definitions/directory-data-region-information-extension-interface" - } - }, - "required": [ - "id", - "code", - "name" - ] - }, - "directory-data-region-information-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface" - }, - "directory-data-country-information-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface" - }, - "eav-data-attribute-set-search-results-interface": { - "type": "object", - "description": "Interface AttributeSetSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Attribute sets list.", - "items": { - "$ref": "#/definitions/eav-data-attribute-set-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "framework-search-criteria-interface": { - "type": "object", - "description": "Search criteria interface.", - "properties": { - "filter_groups": { - "type": "array", - "description": "A list of filter groups.", - "items": { - "$ref": "#/definitions/framework-search-filter-group" - } - }, - "sort_orders": { - "type": "array", - "description": "Sort order.", - "items": { - "$ref": "#/definitions/framework-sort-order" - } - }, - "page_size": { - "type": "integer", - "description": "Page size." - }, - "current_page": { - "type": "integer", - "description": "Current page." - } - }, - "required": [ - "filter_groups" - ] - }, - "framework-search-filter-group": { - "type": "object", - "description": "Groups two or more filters together using a logical OR", - "properties": { - "filters": { - "type": "array", - "description": "A list of filters in this group", - "items": { - "$ref": "#/definitions/framework-filter" - } - } - } - }, - "framework-filter": { - "type": "object", - "description": "Filter which can be used by any methods from service layer.", - "properties": { - "field": { - "type": "string", - "description": "Field" - }, - "value": { - "type": "string", - "description": "Value" - }, - "condition_type": { - "type": "string", - "description": "Condition type" - } - }, - "required": [ - "field", - "value" - ] - }, - "framework-sort-order": { - "type": "object", - "description": "Data object for sort order.", - "properties": { - "field": { - "type": "string", - "description": "Sorting field." - }, - "direction": { - "type": "string", - "description": "Sorting direction." - } - }, - "required": [ - "field", - "direction" - ] - }, - "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-group-search-results-interface": { - "type": "object", - "description": "Interface for customer groups search results.", - "properties": { - "items": { - "type": "array", - "description": "Customer groups list.", - "items": { - "$ref": "#/definitions/customer-data-group-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "customer-data-attribute-metadata-interface": { - "type": "object", - "description": "Customer attribute metadata interface.", - "properties": { - "frontend_input": { - "type": "string", - "description": "HTML for input element." - }, - "input_filter": { - "type": "string", - "description": "Template used for input (e.g. \"date\")" - }, - "store_label": { - "type": "string", - "description": "Label of the store." - }, - "validation_rules": { - "type": "array", - "description": "Validation rules.", - "items": { - "$ref": "#/definitions/customer-data-validation-rule-interface" - } - }, - "multiline_count": { - "type": "integer", - "description": "Of lines of the attribute value." - }, - "visible": { - "type": "boolean", - "description": "Attribute is visible on frontend." - }, - "required": { - "type": "boolean", - "description": "Attribute is required." - }, - "data_model": { - "type": "string", - "description": "Data model for attribute." - }, - "options": { - "type": "array", - "description": "Options of the attribute (key => value pairs for select)", - "items": { - "$ref": "#/definitions/customer-data-option-interface" - } - }, - "frontend_class": { - "type": "string", - "description": "Class which is used to display the attribute on frontend." - }, - "user_defined": { - "type": "boolean", - "description": "Current attribute has been defined by a user." - }, - "sort_order": { - "type": "integer", - "description": "Attributes sort order." - }, - "frontend_label": { - "type": "string", - "description": "Label which supposed to be displayed on frontend." - }, - "note": { - "type": "string", - "description": "The note attribute for the element." - }, - "system": { - "type": "boolean", - "description": "This is a system attribute." - }, - "backend_type": { - "type": "string", - "description": "Backend type." - }, - "is_used_in_grid": { - "type": "boolean", - "description": "It is used in customer grid" - }, - "is_visible_in_grid": { - "type": "boolean", - "description": "It is visible in customer grid" - }, - "is_filterable_in_grid": { - "type": "boolean", - "description": "It is filterable in customer grid" - }, - "is_searchable_in_grid": { - "type": "boolean", - "description": "It is searchable in customer grid" - }, - "attribute_code": { - "type": "string", - "description": "Code of the attribute." - } - }, - "required": [ - "frontend_input", - "input_filter", - "store_label", - "validation_rules", - "multiline_count", - "visible", - "required", - "data_model", - "options", - "frontend_class", - "user_defined", - "sort_order", - "frontend_label", - "note", - "system", - "backend_type", - "attribute_code" - ] - }, - "customer-data-validation-rule-interface": { - "type": "object", - "description": "Validation rule interface.", - "properties": { - "name": { - "type": "string", - "description": "Validation rule name" - }, - "value": { - "type": "string", - "description": "Validation rule value" - } - }, - "required": [ - "name", - "value" - ] - }, - "customer-data-option-interface": { - "type": "object", - "description": "Option interface.", - "properties": { - "label": { - "type": "string", - "description": "Option label" - }, - "value": { - "type": "string", - "description": "Option value" - }, - "options": { - "type": "array", - "description": "Nested options", - "items": { - "$ref": "#/definitions/customer-data-option-interface" - } - } - }, - "required": [ - "label" - ] - }, - "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" - }, - "customer-data-customer-search-results-interface": { - "type": "object", - "description": "Interface for customer search results.", - "properties": { - "items": { - "type": "array", - "description": "Customers list.", - "items": { - "$ref": "#/definitions/customer-data-customer-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "customer-data-validation-results-interface": { - "type": "object", - "description": "Validation results interface.", - "properties": { - "valid": { - "type": "boolean", - "description": "If the provided data is valid." - }, - "messages": { - "type": "array", - "description": "Error messages as array in case of validation failure, else return empty array.", - "items": { - "type": "string" - } - } - }, - "required": [ - "valid", - "messages" - ] - }, - "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-page-search-results-interface": { - "type": "object", - "description": "Interface for cms page search results.", - "properties": { - "items": { - "type": "array", - "description": "Pages list.", - "items": { - "$ref": "#/definitions/cms-data-page-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - ] - }, - "cms-data-block-search-results-interface": { - "type": "object", - "description": "Interface for cms block search results.", - "properties": { - "items": { - "type": "array", - "description": "Blocks list.", - "items": { - "$ref": "#/definitions/cms-data-block-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - } - }, - "bundle_product_options": { - "type": "array", - "items": { - "$ref": "#/definitions/bundle-data-option-interface" - } - }, - "stock_item": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-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" - }, - "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" - }, - "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" - }, - "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" - }, - "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-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Attributes list.", - "items": { - "$ref": "#/definitions/catalog-data-product-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-product-attribute-type-interface": { - "type": "object", - "description": "", - "properties": { - "value": { - "type": "string", - "description": "Value" - }, - "label": { - "type": "string", - "description": "Type label" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-attribute-type-extension-interface" - } - }, - "required": [ - "value", - "label" - ] - }, - "catalog-data-product-attribute-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface" - }, - "catalog-data-product-attribute-interface": { - "type": "object", - "description": "", - "properties": { - "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" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-eav-attribute-extension-interface" - }, - "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" - ] - }, - "catalog-data-eav-attribute-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface" - }, - "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" - ] - }, - "catalog-data-product-attribute-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Attributes list.", - "items": { - "$ref": "#/definitions/catalog-data-product-attribute-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-category-attribute-interface": { - "type": "object", - "description": "", - "properties": { - "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" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-eav-attribute-extension-interface" - }, - "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" - ] - }, - "catalog-data-category-attribute-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Attributes list.", - "items": { - "$ref": "#/definitions/catalog-data-category-attribute-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-product-type-interface": { - "type": "object", - "description": "Product type details", - "properties": { - "name": { - "type": "string", - "description": "Product type code" - }, - "label": { - "type": "string", - "description": "Product type label" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-type-extension-interface" - } - }, - "required": [ - "name", - "label" - ] - }, - "catalog-data-product-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface" - }, - "eav-data-attribute-group-search-results-interface": { - "type": "object", - "description": "Interface AttributeGroupSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Attribute sets list.", - "items": { - "$ref": "#/definitions/eav-data-attribute-group-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-price-update-result-interface": { - "type": "object", - "description": "Interface returned in case of incorrect price passed to efficient price API.", - "properties": { - "message": { - "type": "string", - "description": "Error message, that contains description of error occurred during price update." - }, - "parameters": { - "type": "array", - "description": "Parameters, that could be displayed in error message placeholders.", - "items": { - "type": "string" - } - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-price-update-result-extension-interface" - } - }, - "required": [ - "message", - "parameters" - ] - }, - "catalog-data-price-update-result-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface" - }, - "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": "", - "properties": { - "id": { - "type": "integer" - }, - "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" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "path": { - "type": "string" - }, - "available_sort_by": { - "type": "array", - "items": { - "type": "string" - } - }, - "include_in_menu": { - "type": "boolean" - }, - "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-tree-interface": { - "type": "object", - "description": "", - "properties": { - "id": { - "type": "integer" - }, - "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" - }, - "product_count": { - "type": "integer", - "description": "Product count" - }, - "children_data": { - "type": "array", - "items": { - "$ref": "#/definitions/catalog-data-category-tree-interface" - } - } - }, - "required": [ - "parent_id", - "name", - "is_active", - "position", - "level", - "product_count", - "children_data" - ] - }, - "catalog-data-category-search-results-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Categories", - "items": { - "$ref": "#/definitions/catalog-data-category-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-data-product-custom-option-type-interface": { - "type": "object", - "description": "", - "properties": { - "label": { - "type": "string", - "description": "Option type label" - }, - "code": { - "type": "string", - "description": "Option type code" - }, - "group": { - "type": "string", - "description": "Option type group" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-custom-option-type-extension-interface" - } - }, - "required": [ - "label", - "code", - "group" - ] - }, - "catalog-data-product-custom-option-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface" - }, - "catalog-data-product-link-type-interface": { - "type": "object", - "description": "", - "properties": { - "code": { - "type": "integer", - "description": "Link type code" - }, - "name": { - "type": "string", - "description": "Link type name" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-link-type-extension-interface" - } - }, - "required": [ - "code", - "name" - ] - }, - "catalog-data-product-link-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface" - }, - "catalog-data-product-link-attribute-interface": { - "type": "object", - "description": "", - "properties": { - "code": { - "type": "string", - "description": "Attribute code" - }, - "type": { - "type": "string", - "description": "Attribute type" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-link-attribute-extension-interface" - } - }, - "required": [ - "code", - "type" - ] - }, - "catalog-data-product-link-attribute-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface" - }, - "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" - ] - }, - "catalog-data-product-render-search-results-interface": { - "type": "object", - "description": "Dto that holds render information about products", - "properties": { - "items": { - "type": "array", - "description": "List of products rendered information", - "items": { - "$ref": "#/definitions/catalog-data-product-render-interface" - } - } - }, - "required": [ - "items" - ] - }, - "catalog-data-product-render-interface": { - "type": "object", - "description": "Represents Data Object which holds enough information to render product This information is put into part as Add To Cart or Add to Compare Data or Price Data", - "properties": { - "add_to_cart_button": { - "$ref": "#/definitions/catalog-data-product-render-button-interface" - }, - "add_to_compare_button": { - "$ref": "#/definitions/catalog-data-product-render-button-interface" - }, - "price_info": { - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - }, - "images": { - "type": "array", - "description": "Enough information, that needed to render image on front", - "items": { - "$ref": "#/definitions/catalog-data-product-render-image-interface" - } - }, - "url": { - "type": "string", - "description": "Product url" - }, - "id": { - "type": "integer", - "description": "Product identifier" - }, - "name": { - "type": "string", - "description": "Product name" - }, - "type": { - "type": "string", - "description": "Product type. Such as bundle, grouped, simple, etc..." - }, - "is_salable": { - "type": "string", - "description": "Information about product saleability (In Stock)" - }, - "store_id": { - "type": "integer", - "description": "Information about current store id or requested store id" - }, - "currency_code": { - "type": "string", - "description": "Current or desired currency code to product" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-extension-interface" - } - }, - "required": [ - "add_to_cart_button", - "add_to_compare_button", - "price_info", - "images", - "url", - "id", - "name", - "type", - "is_salable", - "store_id", - "currency_code", - "extension_attributes" - ] - }, - "catalog-data-product-render-button-interface": { - "type": "object", - "description": "Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend", - "properties": { - "post_data": { - "type": "string", - "description": "Post data" - }, - "url": { - "type": "string", - "description": "Url, needed to add product to cart" - }, - "required_options": { - "type": "boolean", - "description": "Flag whether a product has options or not" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-button-extension-interface" - } - }, - "required": [ - "post_data", - "url", - "required_options" - ] - }, - "catalog-data-product-render-button-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ButtonInterface" - }, - "catalog-data-product-render-price-info-interface": { - "type": "object", - "description": "Price interface.", - "properties": { - "final_price": { - "type": "number", - "description": "Final price" - }, - "max_price": { - "type": "number", - "description": "Max price of a product" - }, - "max_regular_price": { - "type": "number", - "description": "Max regular price" - }, - "minimal_regular_price": { - "type": "number", - "description": "Minimal regular price" - }, - "special_price": { - "type": "number", - "description": "Special price" - }, - "minimal_price": { - "type": "number" - }, - "regular_price": { - "type": "number", - "description": "Regular price" - }, - "formatted_prices": { - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-interface" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-price-info-extension-interface" - } - }, - "required": [ - "final_price", - "max_price", - "max_regular_price", - "minimal_regular_price", - "special_price", - "minimal_price", - "regular_price", - "formatted_prices" - ] - }, - "catalog-data-product-render-formatted-price-info-interface": { - "type": "object", - "description": "Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html", - "properties": { - "final_price": { - "type": "string", - "description": "Html with final price" - }, - "max_price": { - "type": "string", - "description": "Max price of a product" - }, - "minimal_price": { - "type": "string", - "description": "The minimal price of the product or variation" - }, - "max_regular_price": { - "type": "string", - "description": "Max regular price" - }, - "minimal_regular_price": { - "type": "string", - "description": "Minimal regular price" - }, - "special_price": { - "type": "string", - "description": "Special price" - }, - "regular_price": { - "type": "string", - "description": "Price - is price of product without discounts and special price with taxes and fixed product tax" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-formatted-price-info-extension-interface" - } - }, - "required": [ - "final_price", - "max_price", - "minimal_price", - "max_regular_price", - "minimal_regular_price", - "special_price", - "regular_price" - ] - }, - "catalog-data-product-render-formatted-price-info-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\FormattedPriceInfoInterface" - }, - "catalog-data-product-render-price-info-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\PriceInfoInterface", - "properties": { - "msrp": { - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-interface" - }, - "tax_adjustments": { - "$ref": "#/definitions/catalog-data-product-render-price-info-interface" - }, - "weee_attributes": { - "type": "array", - "items": { - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-interface" - } - }, - "weee_adjustment": { - "type": "string" - } - } - }, - "msrp-data-product-render-msrp-price-info-interface": { - "type": "object", - "description": "Price interface.", - "properties": { - "msrp_price": { - "type": "string" - }, - "is_applicable": { - "type": "string" - }, - "is_shown_price_on_gesture": { - "type": "string" - }, - "msrp_message": { - "type": "string" - }, - "explanation_message": { - "type": "string" - }, - "extension_attributes": { - "$ref": "#/definitions/msrp-data-product-render-msrp-price-info-extension-interface" - } - }, - "required": [ - "msrp_price", - "is_applicable", - "is_shown_price_on_gesture", - "msrp_message", - "explanation_message" - ] - }, - "msrp-data-product-render-msrp-price-info-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Msrp\\Api\\Data\\ProductRender\\MsrpPriceInfoInterface" - }, - "weee-data-product-render-weee-adjustment-attribute-interface": { - "type": "object", - "description": "List of all weee attributes, their amounts, etc.., that product has", - "properties": { - "amount": { - "type": "string", - "description": "Weee attribute amount" - }, - "tax_amount": { - "type": "string", - "description": "Tax which is calculated to fixed product tax attribute" - }, - "tax_amount_incl_tax": { - "type": "string", - "description": "Tax amount of weee attribute" - }, - "amount_excl_tax": { - "type": "string", - "description": "Product amount exclude tax" - }, - "attribute_code": { - "type": "string", - "description": "Weee attribute code" - }, - "extension_attributes": { - "$ref": "#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface" - } - }, - "required": [ - "amount", - "tax_amount", - "tax_amount_incl_tax", - "amount_excl_tax", - "attribute_code", - "extension_attributes" - ] - }, - "weee-data-product-render-weee-adjustment-attribute-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Weee\\Api\\Data\\ProductRender\\WeeeAdjustmentAttributeInterface" - }, - "catalog-data-product-render-image-interface": { - "type": "object", - "description": "Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view", - "properties": { - "url": { - "type": "string", - "description": "Image url" - }, - "code": { - "type": "string", - "description": "Image code" - }, - "height": { - "type": "number", - "description": "Image height" - }, - "width": { - "type": "number", - "description": "Image width in px" - }, - "label": { - "type": "string", - "description": "Image label" - }, - "resized_width": { - "type": "number", - "description": "Resize width" - }, - "resized_height": { - "type": "number", - "description": "Resize height" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-data-product-render-image-extension-interface" - } - }, - "required": [ - "url", - "code", - "height", - "width", - "label", - "resized_width", - "resized_height" - ] - }, - "catalog-data-product-render-image-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ImageInterface" - }, - "catalog-data-product-render-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRenderInterface", - "properties": { - "wishlist_button": { - "$ref": "#/definitions/catalog-data-product-render-button-interface" - }, - "review_html": { - "type": "string" - } - } - }, - "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" - }, - "quote-data-cart-item-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface", - "properties": { - "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-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": { - "gift_registry_id": { - "type": "integer" - }, - "checkout_fields": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - } - }, - "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": { - "type": "string" - } - } - }, - "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" - }, - "quote-data-cart-search-results-interface": { - "type": "object", - "description": "Interface CartSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Carts list.", - "items": { - "$ref": "#/definitions/quote-data-cart-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-shipping-method-interface": { - "type": "object", - "description": "Interface ShippingMethodInterface", - "properties": { - "carrier_code": { - "type": "string", - "description": "Shipping carrier code." - }, - "method_code": { - "type": "string", - "description": "Shipping method code." - }, - "carrier_title": { - "type": "string", - "description": "Shipping carrier title. Otherwise, null." - }, - "method_title": { - "type": "string", - "description": "Shipping method title. Otherwise, null." - }, - "amount": { - "type": "number", - "description": "Shipping amount in store currency." - }, - "base_amount": { - "type": "number", - "description": "Shipping amount in base currency." - }, - "available": { - "type": "boolean", - "description": "The value of the availability flag for the current shipping method." - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-shipping-method-extension-interface" - }, - "error_message": { - "type": "string", - "description": "Shipping Error message." - }, - "price_excl_tax": { - "type": "number", - "description": "Shipping price excl tax." - }, - "price_incl_tax": { - "type": "number", - "description": "Shipping price incl tax." - } - }, - "required": [ - "carrier_code", - "method_code", - "amount", - "base_amount", - "available", - "error_message", - "price_excl_tax", - "price_incl_tax" - ] - }, - "quote-data-shipping-method-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface" - }, - "quote-data-payment-method-interface": { - "type": "object", - "description": "Interface PaymentMethodInterface", - "properties": { - "code": { - "type": "string", - "description": "Payment method code" - }, - "title": { - "type": "string", - "description": "Payment method title" - } - }, - "required": [ - "code", - "title" - ] - }, - "quote-data-totals-interface": { - "type": "object", - "description": "Interface TotalsInterface", - "properties": { - "grand_total": { - "type": "number", - "description": "Grand total in quote currency" - }, - "base_grand_total": { - "type": "number", - "description": "Grand total in base currency" - }, - "subtotal": { - "type": "number", - "description": "Subtotal in quote currency" - }, - "base_subtotal": { - "type": "number", - "description": "Subtotal in base currency" - }, - "discount_amount": { - "type": "number", - "description": "Discount amount in quote currency" - }, - "base_discount_amount": { - "type": "number", - "description": "Discount amount in base currency" - }, - "subtotal_with_discount": { - "type": "number", - "description": "Subtotal in quote currency with applied discount" - }, - "base_subtotal_with_discount": { - "type": "number", - "description": "Subtotal in base currency with applied discount" - }, - "shipping_amount": { - "type": "number", - "description": "Shipping amount in quote currency" - }, - "base_shipping_amount": { - "type": "number", - "description": "Shipping amount in base currency" - }, - "shipping_discount_amount": { - "type": "number", - "description": "Shipping discount amount in quote currency" - }, - "base_shipping_discount_amount": { - "type": "number", - "description": "Shipping discount amount in base currency" - }, - "tax_amount": { - "type": "number", - "description": "Tax amount in quote currency" - }, - "base_tax_amount": { - "type": "number", - "description": "Tax amount in base currency" - }, - "weee_tax_applied_amount": { - "type": "number", - "description": "Item weee tax applied amount in quote currency." - }, - "shipping_tax_amount": { - "type": "number", - "description": "Shipping tax amount in quote currency" - }, - "base_shipping_tax_amount": { - "type": "number", - "description": "Shipping tax amount in base currency" - }, - "subtotal_incl_tax": { - "type": "number", - "description": "Subtotal including tax in quote currency" - }, - "base_subtotal_incl_tax": { - "type": "number", - "description": "Subtotal including tax in base currency" - }, - "shipping_incl_tax": { - "type": "number", - "description": "Shipping including tax in quote currency" - }, - "base_shipping_incl_tax": { - "type": "number", - "description": "Shipping including tax in base currency" - }, - "base_currency_code": { - "type": "string", - "description": "Base currency code" - }, - "quote_currency_code": { - "type": "string", - "description": "Quote currency code" - }, - "coupon_code": { - "type": "string", - "description": "Applied coupon code" - }, - "items_qty": { - "type": "integer", - "description": "Items qty" - }, - "items": { - "type": "array", - "description": "Totals by items", - "items": { - "$ref": "#/definitions/quote-data-totals-item-interface" - } - }, - "total_segments": { - "type": "array", - "description": "Dynamically calculated totals", - "items": { - "$ref": "#/definitions/quote-data-total-segment-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-totals-extension-interface" - } - }, - "required": [ - "weee_tax_applied_amount", - "total_segments" - ] - }, - "quote-data-totals-item-interface": { - "type": "object", - "description": "Interface TotalsItemInterface", - "properties": { - "item_id": { - "type": "integer", - "description": "Item id" - }, - "price": { - "type": "number", - "description": "Item price in quote currency." - }, - "base_price": { - "type": "number", - "description": "Item price in base currency." - }, - "qty": { - "type": "number", - "description": "Item quantity." - }, - "row_total": { - "type": "number", - "description": "Row total in quote currency." - }, - "base_row_total": { - "type": "number", - "description": "Row total in base currency." - }, - "row_total_with_discount": { - "type": "number", - "description": "Row total with discount in quote currency. Otherwise, null." - }, - "tax_amount": { - "type": "number", - "description": "Tax amount in quote currency. Otherwise, null." - }, - "base_tax_amount": { - "type": "number", - "description": "Tax amount in base currency. Otherwise, null." - }, - "tax_percent": { - "type": "number", - "description": "Tax percent. Otherwise, null." - }, - "discount_amount": { - "type": "number", - "description": "Discount amount in quote currency. Otherwise, null." - }, - "base_discount_amount": { - "type": "number", - "description": "Discount amount in base currency. Otherwise, null." - }, - "discount_percent": { - "type": "number", - "description": "Discount percent. Otherwise, null." - }, - "price_incl_tax": { - "type": "number", - "description": "Price including tax in quote currency. Otherwise, null." - }, - "base_price_incl_tax": { - "type": "number", - "description": "Price including tax in base currency. Otherwise, null." - }, - "row_total_incl_tax": { - "type": "number", - "description": "Row total including tax in quote currency. Otherwise, null." - }, - "base_row_total_incl_tax": { - "type": "number", - "description": "Row total including tax in base currency. Otherwise, null." - }, - "options": { - "type": "string", - "description": "Item price in quote currency." - }, - "weee_tax_applied_amount": { - "type": "number", - "description": "Item weee tax applied amount in quote currency." - }, - "weee_tax_applied": { - "type": "string", - "description": "Item weee tax applied in quote currency." - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-totals-item-extension-interface" - }, - "name": { - "type": "string", - "description": "Product name. Otherwise, null." - } - }, - "required": [ - "item_id", - "price", - "base_price", - "qty", - "row_total", - "base_row_total", - "options", - "weee_tax_applied_amount", - "weee_tax_applied" - ] - }, - "quote-data-totals-item-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface", - "properties": { - "negotiable_quote_item_totals": { - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface" - } - } - }, - "negotiable-quote-data-negotiable-quote-item-totals-interface": { - "type": "object", - "description": "Extension attribute for quote item totals model.", - "properties": { - "cost": { - "type": "number", - "description": "Cost for quote item." - }, - "catalog_price": { - "type": "number", - "description": "Catalog price for quote item." - }, - "base_catalog_price": { - "type": "number", - "description": "Catalog price for quote item in base currency." - }, - "catalog_price_incl_tax": { - "type": "number", - "description": "Catalog price with included tax for quote item." - }, - "base_catalog_price_incl_tax": { - "type": "number", - "description": "Catalog price with included tax for quote item in base currency." - }, - "cart_price": { - "type": "number", - "description": "Cart price for quote item." - }, - "base_cart_price": { - "type": "number", - "description": "Cart price for quote item in base currency." - }, - "cart_tax": { - "type": "number", - "description": "Tax from catalog price for quote item." - }, - "base_cart_tax": { - "type": "number", - "description": "Tax from catalog price for quote item in base currency." - }, - "cart_price_incl_tax": { - "type": "number", - "description": "Cart price with included tax for quote item." - }, - "base_cart_price_incl_tax": { - "type": "number", - "description": "Cart price with included tax for quote item in base currency." - }, - "extension_attributes": { - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface" - } - }, - "required": [ - "cost", - "catalog_price", - "base_catalog_price", - "catalog_price_incl_tax", - "base_catalog_price_incl_tax", - "cart_price", - "base_cart_price", - "cart_tax", - "base_cart_tax", - "cart_price_incl_tax", - "base_cart_price_incl_tax" - ] - }, - "negotiable-quote-data-negotiable-quote-item-totals-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteItemTotalsInterface" - }, - "quote-data-total-segment-interface": { - "type": "object", - "description": "Interface TotalsInterface", - "properties": { - "code": { - "type": "string", - "description": "Code" - }, - "title": { - "type": "string", - "description": "Total title" - }, - "value": { - "type": "number", - "description": "Total value" - }, - "area": { - "type": "string", - "description": "Display area code." - }, - "extension_attributes": { - "$ref": "#/definitions/quote-data-total-segment-extension-interface" - } - }, - "required": [ - "code", - "value" - ] - }, - "quote-data-total-segment-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface", - "properties": { - "tax_grandtotal_details": { - "type": "array", - "items": { - "$ref": "#/definitions/tax-data-grand-total-details-interface" - } - }, - "gift_cards": { - "type": "string" - }, - "gw_order_id": { - "type": "string" - }, - "gw_item_ids": { - "type": "array", - "items": { - "type": "string" - } - }, - "gw_allow_gift_receipt": { - "type": "string" - }, - "gw_add_card": { - "type": "string" - }, - "gw_price": { - "type": "string" - }, - "gw_base_price": { - "type": "string" - }, - "gw_items_price": { - "type": "string" - }, - "gw_items_base_price": { - "type": "string" - }, - "gw_card_price": { - "type": "string" - }, - "gw_card_base_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_price_incl_tax": { - "type": "string" - }, - "gw_base_price_incl_tax": { - "type": "string" - }, - "gw_card_price_incl_tax": { - "type": "string" - }, - "gw_card_base_price_incl_tax": { - "type": "string" - }, - "gw_items_price_incl_tax": { - "type": "string" - }, - "gw_items_base_price_incl_tax": { - "type": "string" - }, - "vertex_tax_calculation_messages": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "tax-data-grand-total-details-interface": { - "type": "object", - "description": "Interface GrandTotalDetailsInterface", - "properties": { - "amount": { - "type": "number", - "description": "Tax amount value" - }, - "rates": { - "type": "array", - "description": "Tax rates info", - "items": { - "$ref": "#/definitions/tax-data-grand-total-rates-interface" - } - }, - "group_id": { - "type": "integer", - "description": "Group identifier" - } - }, - "required": [ - "amount", - "rates", - "group_id" - ] - }, - "tax-data-grand-total-rates-interface": { - "type": "object", - "description": "Interface GrandTotalRatesInterface", - "properties": { - "percent": { - "type": "string", - "description": "Tax percentage value" - }, - "title": { - "type": "string", - "description": "Rate title" - } - }, - "required": [ - "percent", - "title" - ] - }, - "quote-data-totals-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface", - "properties": { - "coupon_label": { - "type": "string" - }, - "base_customer_balance_amount": { - "type": "number" - }, - "customer_balance_amount": { - "type": "number" - }, - "negotiable_quote_totals": { - "$ref": "#/definitions/negotiable-quote-data-negotiable-quote-totals-interface" - }, - "reward_points_balance": { - "type": "number" - }, - "reward_currency_amount": { - "type": "number" - }, - "base_reward_currency_amount": { - "type": "number" - } - } - }, - "negotiable-quote-data-negotiable-quote-totals-interface": { - "type": "object", - "description": "Extension attribute for quote totals model.", - "properties": { - "items_count": { - "type": "integer", - "description": "The number of different items or products in the cart." - }, - "quote_status": { - "type": "string", - "description": "Negotiable quote status." - }, - "created_at": { - "type": "string", - "description": "The cart creation date and time." - }, - "updated_at": { - "type": "string", - "description": "The cart last update date and time." - }, - "customer_group": { - "type": "integer", - "description": "Customer group id." - }, - "base_to_quote_rate": { - "type": "number", - "description": "Base currency to quote currency rate." - }, - "cost_total": { - "type": "number", - "description": "Total cost for quote." - }, - "base_cost_total": { - "type": "number", - "description": "Total cost for quote in base currency." - }, - "original_total": { - "type": "number", - "description": "Original quote total." - }, - "base_original_total": { - "type": "number", - "description": "Original quote total in base currency." - }, - "original_tax": { - "type": "number", - "description": "Original tax amount for quote." - }, - "base_original_tax": { - "type": "number", - "description": "Original tax amount for quote in base currency." - }, - "original_price_incl_tax": { - "type": "number", - "description": "Original price with included tax for quote." - }, - "base_original_price_incl_tax": { - "type": "number", - "description": "Original price with included tax for quote in base currency." - }, - "negotiated_price_type": { - "type": "integer", - "description": "Negotiable quote type." - }, - "negotiated_price_value": { - "type": "number", - "description": "Negotiable price value for quote." - } - }, - "required": [ - "items_count", - "quote_status", - "created_at", - "updated_at", - "customer_group", - "base_to_quote_rate", - "cost_total", - "base_cost_total", - "original_total", - "base_original_total", - "original_tax", - "base_original_tax", - "original_price_incl_tax", - "base_original_price_incl_tax", - "negotiated_price_type", - "negotiated_price_value" - ] - }, - "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" - } - } - }, - "bundle-data-option-type-interface": { - "type": "object", - "description": "Interface OptionTypeInterface", - "properties": { - "label": { - "type": "string", - "description": "Type label" - }, - "code": { - "type": "string", - "description": "Type code" - }, - "extension_attributes": { - "$ref": "#/definitions/bundle-data-option-type-extension-interface" - } - }, - "required": [ - "label", - "code" - ] - }, - "bundle-data-option-type-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface" - }, - "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": "string", - "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" - }, - "framework-search-search-result-interface": { - "type": "object", - "description": "Interface SearchResultInterface", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-search-document-interface" - } - }, - "aggregations": { - "$ref": "#/definitions/framework-search-aggregation-interface" - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "aggregations", - "search_criteria", - "total_count" - ] - }, - "framework-search-document-interface": { - "type": "object", - "description": "Interface \\Magento\\Framework\\Api\\Search\\DocumentInterface", - "properties": { - "id": { - "type": "integer" - }, - "custom_attributes": { - "type": "array", - "description": "Custom attributes values.", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - }, - "required": [ - "id" - ] - }, - "framework-search-aggregation-interface": { - "type": "object", - "description": "Faceted data", - "properties": { - "buckets": { - "type": "array", - "description": "All Document fields", - "items": { - "$ref": "#/definitions/framework-search-bucket-interface" - } - }, - "bucket_names": { - "type": "array", - "description": "Document field names", - "items": { - "type": "string" - } - } - }, - "required": [ - "buckets", - "bucket_names" - ] - }, - "framework-search-bucket-interface": { - "type": "object", - "description": "Facet Bucket", - "properties": { - "name": { - "type": "string", - "description": "Field name" - }, - "values": { - "type": "array", - "description": "Field values", - "items": { - "$ref": "#/definitions/framework-search-aggregation-value-interface" - } - } - }, - "required": [ - "name", - "values" - ] - }, - "framework-search-aggregation-value-interface": { - "type": "object", - "description": "Interface \\Magento\\Framework\\Api\\Search\\AggregationValueInterface", - "properties": { - "value": { - "type": "string", - "description": "Aggregation" - }, - "metrics": { - "type": "array", - "description": "Metrics", - "items": { - "type": "string" - } - } - }, - "required": [ - "value", - "metrics" - ] - }, - "framework-search-search-criteria-interface": { - "type": "object", - "description": "Interface SearchCriteriaInterface", - "properties": { - "request_name": { - "type": "string" - }, - "filter_groups": { - "type": "array", - "description": "A list of filter groups.", - "items": { - "$ref": "#/definitions/framework-search-filter-group" - } - }, - "sort_orders": { - "type": "array", - "description": "Sort order.", - "items": { - "$ref": "#/definitions/framework-sort-order" - } - }, - "page_size": { - "type": "integer", - "description": "Page size." - }, - "current_page": { - "type": "integer", - "description": "Current page." - } - }, - "required": [ - "request_name", - "filter_groups" - ] - }, - "catalog-inventory-data-stock-item-collection-interface": { - "type": "object", - "description": "Interface StockItemCollectionInterface", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/catalog-inventory-stock-item-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "catalog-inventory-stock-item-criteria-interface": { - "type": "object", - "description": "Interface StockItemCriteriaInterface", - "properties": { - "mapper_interface_name": { - "type": "string", - "description": "Associated Mapper Interface name" - }, - "criteria_list": { - "type": "array", - "description": "Criteria objects added to current Composite Criteria", - "items": { - "$ref": "#/definitions/framework-criteria-interface" - } - }, - "filters": { - "type": "array", - "description": "List of filters", - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Ordering criteria", - "items": { - "type": "string" - } - }, - "limit": { - "type": "array", - "description": "Limit", - "items": { - "type": "string" - } - } - }, - "required": [ - "mapper_interface_name", - "criteria_list", - "filters", - "orders", - "limit" - ] - }, - "framework-criteria-interface": { - "type": "object", - "description": "Interface CriteriaInterface", - "properties": { - "mapper_interface_name": { - "type": "string", - "description": "Associated Mapper Interface name" - }, - "criteria_list": { - "type": "array", - "description": "Criteria objects added to current Composite Criteria", - "items": { - "$ref": "#/definitions/framework-criteria-interface" - } - }, - "filters": { - "type": "array", - "description": "List of filters", - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Ordering criteria", - "items": { - "type": "string" - } - }, - "limit": { - "type": "array", - "description": "Limit", - "items": { - "type": "string" - } - } - }, - "required": [ - "mapper_interface_name", - "criteria_list", - "filters", - "orders", - "limit" - ] - }, - "catalog-inventory-data-stock-status-interface": { - "type": "object", - "description": "Interface StockStatusInterface", - "properties": { - "product_id": { - "type": "integer" - }, - "stock_id": { - "type": "integer" - }, - "qty": { - "type": "integer" - }, - "stock_status": { - "type": "integer" - }, - "stock_item": { - "$ref": "#/definitions/catalog-inventory-data-stock-item-interface" - }, - "extension_attributes": { - "$ref": "#/definitions/catalog-inventory-data-stock-status-extension-interface" - } - }, - "required": [ - "product_id", - "stock_id", - "qty", - "stock_status", - "stock_item" - ] - }, - "catalog-inventory-data-stock-status-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface" - }, - "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", - "properties": { - "checkout_fields": { - "type": "array", - "items": { - "$ref": "#/definitions/framework-attribute-interface" - } - } - } - }, - "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": { - "type": "string" - } - } - }, - "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", - "properties": { - "ext_order_id": { - "type": "string" - }, - "shipping_experience": { - "$ref": "#/definitions/temando-shipping-data-order-shipping-experience-interface" - }, - "collection_point": { - "$ref": "#/definitions/temando-shipping-data-collection-point-order-collection-point-interface" - } - } - }, - "temando-shipping-data-order-shipping-experience-interface": { - "type": "object", - "description": "Temando Shipping Experience Interface Local representation of a shipping rate in checkout. A set of shipping experiences is the result of creating an order at the Temando platform. (!) Needs to reside in Api namespace because selected shipping experience is exposed to public as a ShippingInterface extension attribute.", - "properties": { - "label": { - "type": "string" - }, - "code": { - "type": "string" - }, - "cost": { - "type": "number" - } - }, - "required": [ - "label", - "code", - "cost" - ] - }, - "temando-shipping-data-collection-point-order-collection-point-interface": { - "type": "object", - "description": "Temando Order Collection Point Interface – Order Details/Fulfillment", - "properties": { - "recipient_address_id": { - "type": "integer" - }, - "collection_point_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "country": { - "type": "string" - }, - "region": { - "type": "string" - }, - "postcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "street": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "required": [ - "recipient_address_id", - "collection_point_id", - "name", - "country", - "region", - "postcode", - "city", - "street" - ] - }, - "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" - ] - }, - "sales-data-order-search-result-interface": { - "type": "object", - "description": "Order search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-order-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-order-status-history-search-result-interface": { - "type": "object", - "description": "Order status history search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-order-status-history-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-order-item-search-result-interface": { - "type": "object", - "description": "Order item search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-order-item-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-invoice-search-result-interface": { - "type": "object", - "description": "Invoice search result interface. An invoice is a record of the receipt of payment for an order.", - "properties": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-invoice-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-invoice-comment-search-result-interface": { - "type": "object", - "description": "Invoice comment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-invoice-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-comment-search-result-interface": { - "type": "object", - "description": "Credit memo comment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-creditmemo-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-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-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-creditmemo-search-result-interface": { - "type": "object", - "description": "Credit memo search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-creditmemo-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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": { - "ext_shipment_id": { - "type": "string" - }, - "ext_return_shipment_id": { - "type": "string" - }, - "ext_location_id": { - "type": "string" - }, - "ext_tracking_url": { - "type": "string" - }, - "ext_tracking_reference": { - "type": "string" - } - } - }, - "sales-data-shipment-search-result-interface": { - "type": "object", - "description": "Shipment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-shipment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "sales-data-shipment-comment-search-result-interface": { - "type": "object", - "description": "Shipment comment search result 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": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-shipment-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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": { - "shipping_label": { - "type": "string" - }, - "ext_shipment_id": { - "type": "string" - }, - "ext_return_shipment_id": { - "type": "string" - }, - "ext_location_id": { - "type": "string" - }, - "ext_tracking_url": { - "type": "string" - }, - "ext_tracking_reference": { - "type": "string" - } - } - }, - "sales-data-transaction-interface": { - "type": "object", - "description": "Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.", - "properties": { - "transaction_id": { - "type": "integer", - "description": "Transaction ID." - }, - "parent_id": { - "type": "integer", - "description": "The parent ID for the transaction. Otherwise, null." - }, - "order_id": { - "type": "integer", - "description": "Order ID." - }, - "payment_id": { - "type": "integer", - "description": "Payment ID." - }, - "txn_id": { - "type": "string", - "description": "Transaction business ID." - }, - "parent_txn_id": { - "type": "string", - "description": "Parent transaction business ID." - }, - "txn_type": { - "type": "string", - "description": "Transaction type." - }, - "is_closed": { - "type": "integer", - "description": "Is-closed flag value." - }, - "additional_information": { - "type": "array", - "description": "Array of additional information. Otherwise, null.", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "description": "Created-at timestamp." - }, - "child_transactions": { - "type": "array", - "description": "Array of child transactions.", - "items": { - "$ref": "#/definitions/sales-data-transaction-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/sales-data-transaction-extension-interface" - } - }, - "required": [ - "transaction_id", - "order_id", - "payment_id", - "txn_id", - "parent_txn_id", - "txn_type", - "is_closed", - "created_at", - "child_transactions" - ] - }, - "sales-data-transaction-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface" - }, - "sales-data-transaction-search-result-interface": { - "type": "object", - "description": "Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.", - "properties": { - "items": { - "type": "array", - "description": "Array of collection items.", - "items": { - "$ref": "#/definitions/sales-data-transaction-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "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-payment-details-interface": { - "type": "object", - "description": "Interface PaymentDetailsInterface", - "properties": { - "payment_methods": { - "type": "array", - "items": { - "$ref": "#/definitions/quote-data-payment-method-interface" - } - }, - "totals": { - "$ref": "#/definitions/quote-data-totals-interface" - }, - "extension_attributes": { - "$ref": "#/definitions/checkout-data-payment-details-extension-interface" - } - }, - "required": [ - "payment_methods", - "totals" - ] - }, - "checkout-data-payment-details-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface" - }, - "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-rule-search-result-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Rules.", - "items": { - "$ref": "#/definitions/sales-rule-data-rule-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "sales-rule-data-coupon-search-result-interface": { - "type": "object", - "description": "", - "properties": { - "items": { - "type": "array", - "description": "Rules.", - "items": { - "$ref": "#/definitions/sales-rule-data-coupon-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "sales-rule-data-coupon-mass-delete-result-interface": { - "type": "object", - "description": "Coupon mass delete results interface.", - "properties": { - "failed_items": { - "type": "array", - "description": "List of failed items.", - "items": { - "type": "string" - } - }, - "missing_items": { - "type": "array", - "description": "List of missing items.", - "items": { - "type": "string" - } - } - }, - "required": [ - "failed_items", - "missing_items" - ] - }, - "checkout-agreements-data-agreement-interface": { - "type": "object", - "description": "Interface AgreementInterface", - "properties": { - "agreement_id": { - "type": "integer", - "description": "Agreement ID." - }, - "name": { - "type": "string", - "description": "Agreement name." - }, - "content": { - "type": "string", - "description": "Agreement content." - }, - "content_height": { - "type": "string", - "description": "Agreement content height. Otherwise, null." - }, - "checkbox_text": { - "type": "string", - "description": "Agreement checkbox text." - }, - "is_active": { - "type": "boolean", - "description": "Agreement status." - }, - "is_html": { - "type": "boolean", - "description": "* true - HTML. * false - plain text." - }, - "mode": { - "type": "integer", - "description": "The agreement applied mode." - }, - "extension_attributes": { - "$ref": "#/definitions/checkout-agreements-data-agreement-extension-interface" - } - }, - "required": [ - "agreement_id", - "name", - "content", - "checkbox_text", - "is_active", - "is_html", - "mode" - ] - }, - "checkout-agreements-data-agreement-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface" - }, - "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-rate-search-results-interface": { - "type": "object", - "description": "Interface for tax rate search results.", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/tax-data-tax-rate-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-rule-search-results-interface": { - "type": "object", - "description": "Interface for tax rule search results.", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/tax-data-tax-rule-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "tax-data-tax-class-search-results-interface": { - "type": "object", - "description": "Interface for tax class search results.", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/tax-data-tax-class-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "company-data-company-search-results-interface": { - "type": "object", - "description": "Interface for company search results", - "properties": { - "items": { - "type": "array", - "description": "Companies list", - "items": { - "$ref": "#/definitions/company-data-company-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-search-results-interface": { - "type": "object", - "description": "Interface for company team search results", - "properties": { - "items": { - "type": "array", - "description": "Teams list", - "items": { - "$ref": "#/definitions/company-data-team-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-hierarchy-interface": { - "type": "object", - "description": "Company hierarchy DTO interface for WebAPI.", - "properties": { - "structure_id": { - "type": "integer", - "description": "Structure ID." - }, - "entity_id": { - "type": "integer", - "description": "Entity ID." - }, - "entity_type": { - "type": "string", - "description": "Entity type." - }, - "structure_parent_id": { - "type": "integer", - "description": "Structure parent ID." - }, - "extension_attributes": { - "$ref": "#/definitions/company-data-hierarchy-extension-interface" - } - } - }, - "company-data-hierarchy-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\HierarchyInterface" - }, - "company-data-role-search-results-interface": { - "type": "object", - "description": "Interface for role search results.", - "properties": { - "items": { - "type": "array", - "description": "Roles list.", - "items": { - "$ref": "#/definitions/company-data-role-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "analytics-data-link-interface": { - "type": "object", - "description": "Interface LinkInterface Represents link with collected data and initialized vector for decryption.", - "properties": { - "url": { - "type": "string" - }, - "initialization_vector": { - "type": "string" - } - }, - "required": [ - "url", - "initialization_vector" - ] - }, - "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" - }, - "negotiable-quote-data-comment-interface": { - "type": "object", - "description": "Interface CommentInterface", - "properties": { - "entity_id": { - "type": "integer", - "description": "Comment ID." - }, - "parent_id": { - "type": "integer", - "description": "Negotiable quote ID, that this comment belongs to." - }, - "creator_type": { - "type": "integer", - "description": "The comment creator type." - }, - "is_decline": { - "type": "integer", - "description": "Is quote was declined by seller." - }, - "is_draft": { - "type": "integer", - "description": "Is quote draft flag." - }, - "creator_id": { - "type": "integer", - "description": "Comment creator ID." - }, - "comment": { - "type": "string", - "description": "Comment." - }, - "created_at": { - "type": "string", - "description": "Comment created at." - }, - "extension_attributes": { - "$ref": "#/definitions/negotiable-quote-data-comment-extension-interface" - }, - "attachments": { - "type": "array", - "description": "Existing attachments.", - "items": { - "$ref": "#/definitions/negotiable-quote-data-comment-attachment-interface" - } - } - }, - "required": [ - "entity_id", - "parent_id", - "creator_type", - "is_decline", - "is_draft", - "creator_id", - "comment", - "created_at", - "attachments" - ] - }, - "negotiable-quote-data-comment-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentInterface" - }, - "negotiable-quote-data-comment-attachment-interface": { - "type": "object", - "description": "Interface for quote comment attachment.", - "properties": { - "attachment_id": { - "type": "integer", - "description": "Attachment ID." - }, - "comment_id": { - "type": "integer", - "description": "Comment ID." - }, - "file_name": { - "type": "string", - "description": "File name." - }, - "file_path": { - "type": "string", - "description": "File path." - }, - "file_type": { - "type": "string", - "description": "File type." - }, - "extension_attributes": { - "$ref": "#/definitions/negotiable-quote-data-comment-attachment-extension-interface" - } - }, - "required": [ - "attachment_id", - "comment_id", - "file_name", - "file_path", - "file_type" - ] - }, - "negotiable-quote-data-comment-attachment-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentAttachmentInterface" - }, - "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", - "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" - }, - "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 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" - ] - }, - "shared-catalog-data-search-results-interface": { - "type": "object", - "description": "Interface for Shared Catalog search results.", - "properties": { - "items": { - "type": "array", - "description": "Shared Catalog list.", - "items": { - "$ref": "#/definitions/shared-catalog-data-shared-catalog-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "gift-wrapping-data-wrapping-search-results-interface": { - "type": "object", - "description": "Interface WrappingSearchResultsInterface", - "properties": { - "items": { - "type": "array", - "description": "Items", - "items": { - "$ref": "#/definitions/gift-wrapping-data-wrapping-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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-track-search-result-interface": { - "type": "object", - "description": "Interface TrackSearchResultInterface", - "properties": { - "items": { - "type": "array", - "description": "Rma list", - "items": { - "$ref": "#/definitions/rma-data-track-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "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" - }, - "rma-data-comment-search-result-interface": { - "type": "object", - "description": "Interface CommentSearchResultInterface", - "properties": { - "items": { - "type": "array", - "description": "Rma Status History list", - "items": { - "$ref": "#/definitions/rma-data-comment-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "rma-data-rma-search-result-interface": { - "type": "object", - "description": "Interface RmaSearchResultInterface", - "properties": { - "items": { - "type": "array", - "description": "Rma list", - "items": { - "$ref": "#/definitions/rma-data-rma-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "framework-metadata-object-interface": { - "type": "object", - "description": "Provides metadata about an attribute.", - "properties": { - "attribute_code": { - "type": "string", - "description": "Code of the attribute." - } - }, - "required": [ - "attribute_code" - ] - }, - "company-credit-data-credit-limit-search-results-interface": { - "type": "object", - "description": "Interface for Credit Limit search results.", - "properties": { - "items": { - "type": "array", - "description": "Credit Limit list.", - "items": { - "$ref": "#/definitions/company-credit-data-credit-data-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "company-credit-data-credit-data-interface": { - "type": "object", - "description": "Credit Data 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." - } - }, - "required": [ - "exceed_limit" - ] - }, - "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" - ] - }, - "company-credit-data-history-search-results-interface": { - "type": "object", - "description": "Interface for History search results.", - "properties": { - "items": { - "type": "array", - "description": "History list.", - "items": { - "$ref": "#/definitions/company-credit-data-history-data-interface" - } - }, - "search_criteria": { - "$ref": "#/definitions/framework-search-criteria-interface" - }, - "total_count": { - "type": "integer", - "description": "Total count." - } - }, - "required": [ - "items", - "search_criteria", - "total_count" - ] - }, - "company-credit-data-history-data-interface": { - "type": "object", - "description": "History data transfer object interface.", - "properties": { - "id": { - "type": "integer", - "description": "ID." - }, - "company_credit_id": { - "type": "integer", - "description": "Company credit id." - }, - "user_id": { - "type": "integer", - "description": "User Id." - }, - "user_type": { - "type": "integer", - "description": "User type: integration, admin, customer." - }, - "currency_credit": { - "type": "string", - "description": "Currency code of credit." - }, - "currency_operation": { - "type": "string", - "description": "Currency code of operation." - }, - "rate": { - "type": "number", - "description": "Currency rate between credit and operation currencies." - }, - "rate_credit": { - "type": "number", - "description": "Rate between credit and base currencies." - }, - "amount": { - "type": "number", - "description": "Amount." - }, - "balance": { - "type": "number", - "description": "Outstanding balance." - }, - "credit_limit": { - "type": "number", - "description": "Credit limit." - }, - "available_limit": { - "type": "number", - "description": "Available limit." - }, - "type": { - "type": "integer", - "description": "Type of operation." - }, - "datetime": { - "type": "string", - "description": "Operation datetime." - }, - "purchase_order": { - "type": "string", - "description": "Purchase Order number." - }, - "comment": { - "type": "string", - "description": "Comment." - } - }, - "required": [ - "rate", - "amount", - "balance", - "credit_limit" - ] - }, - "asynchronous-operations-data-detailed-bulk-operations-status-interface": { - "type": "object", - "description": "Interface BulkStatusInterface Bulk summary data with list of operations items full data.", - "properties": { - "operations_list": { - "type": "array", - "description": "Operations list.", - "items": { - "$ref": "#/definitions/asynchronous-operations-data-detailed-operation-status-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface" - }, - "bulk_id": { - "type": "string", - "description": "Bulk uuid" - }, - "description": { - "type": "string", - "description": "Bulk description" - }, - "start_time": { - "type": "string", - "description": "Bulk scheduled time" - }, - "user_id": { - "type": "integer", - "description": "User id" - }, - "operation_count": { - "type": "integer", - "description": "Total number of operations scheduled in scope of this bulk" - } - }, - "required": [ - "operations_list", - "bulk_id", - "description", - "start_time", - "user_id", - "operation_count" - ] - }, - "asynchronous-operations-data-detailed-operation-status-interface": { - "type": "object", - "description": "", - "properties": { - "result_serialized_data": { - "type": "string", - "description": "Serialized Data" - }, - "extension_attributes": { - "$ref": "#/definitions/asynchronous-operations-data-operation-extension-interface" - }, - "id": { - "type": "integer", - "description": "Id" - }, - "bulk_uuid": { - "type": "string", - "description": "Bulk uuid" - }, - "topic_name": { - "type": "string", - "description": "Queue Topic" - }, - "serialized_data": { - "type": "string", - "description": "Data" - }, - "status": { - "type": "integer", - "description": "Operation status" - }, - "result_message": { - "type": "string", - "description": "Result message" - }, - "error_code": { - "type": "integer", - "description": "Error code" - } - }, - "required": [ - "result_serialized_data", - "id", - "bulk_uuid", - "topic_name", - "serialized_data", - "status", - "result_message", - "error_code" - ] - }, - "asynchronous-operations-data-operation-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\OperationInterface" - }, - "asynchronous-operations-data-bulk-summary-extension-interface": { - "type": "object", - "description": "ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\BulkSummaryInterface" - }, - "asynchronous-operations-data-bulk-operations-status-interface": { - "type": "object", - "description": "Interface BulkStatusInterface Bulk summary data with list of operations items summary data.", - "properties": { - "operations_list": { - "type": "array", - "description": "List of operation with statuses (short data).", - "items": { - "$ref": "#/definitions/asynchronous-operations-data-summary-operation-status-interface" - } - }, - "extension_attributes": { - "$ref": "#/definitions/asynchronous-operations-data-bulk-summary-extension-interface" - }, - "bulk_id": { - "type": "string", - "description": "Bulk uuid" - }, - "description": { - "type": "string", - "description": "Bulk description" - }, - "start_time": { - "type": "string", - "description": "Bulk scheduled time" - }, - "user_id": { - "type": "integer", - "description": "User id" - }, - "operation_count": { - "type": "integer", - "description": "Total number of operations scheduled in scope of this bulk" - } - }, - "required": [ - "operations_list", - "bulk_id", - "description", - "start_time", - "user_id", - "operation_count" - ] - }, - "asynchronous-operations-data-summary-operation-status-interface": { - "type": "object", - "description": "Getter Class OperationsStatusInterface Instead of OperationInterface this class don't provide all operation data and not responsive to set any data, just to get operation data without serialized_data and result_serialized_data", - "properties": { - "id": { - "type": "integer", - "description": "Id" - }, - "status": { - "type": "integer", - "description": "Operation status" - }, - "result_message": { - "type": "string", - "description": "Result message" - }, - "error_code": { - "type": "integer", - "description": "Error code" - } - }, - "required": [ - "id", - "status", - "result_message", - "error_code" - ] - }, - "temando-shipping-data-collection-point-search-request-interface": { - "type": "object", - "description": "Temando Collection Point Search Request Interface", - "properties": { - "shipping_address_id": { - "type": "integer" - }, - "country_id": { - "type": "string" - }, - "postcode": { - "type": "string" - }, - "pending": { - "type": "boolean" - } - }, - "required": [ - "shipping_address_id", - "country_id", - "postcode", - "pending" - ] - }, - "temando-shipping-data-collection-point-quote-collection-point-interface": { - "type": "object", - "description": "Temando Quote Collection Point Interface – Checkout/Quoting", - "properties": { - "entity_id": { - "type": "integer" - }, - "collection_point_id": { - "type": "string" - }, - "recipient_address_id": { - "type": "integer" - }, - "name": { - "type": "string" - }, - "country": { - "type": "string" - }, - "region": { - "type": "string" - }, - "postcode": { - "type": "string" - }, - "city": { - "type": "string" - }, - "street": { - "type": "array", - "items": { - "type": "string" - } - }, - "opening_hours": { - "type": "array", - "items": { - "type": "string" - } - }, - "shipping_experiences": { - "type": "array", - "items": { - "type": "string" - } - }, - "selected": { - "type": "boolean" - } - }, - "required": [ - "entity_id", - "collection_point_id", - "recipient_address_id", - "name", - "country", - "region", - "postcode", - "city", - "street", - "opening_hours", - "shipping_experiences", - "selected" - ] - } - } -} \ No newline at end of file diff --git a/src/swagger/schemas/latest-2.3.schema.json b/src/swagger/schemas/latest-2.3.schema.json deleted file mode 100644 index ae6127415f3..00000000000 --- a/src/swagger/schemas/latest-2.3.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"dev-2.3-develop","title":"Magento Open Source, Commerce, and Commerce for B2B 2.3"},"host":"magento2.vagrant12","basePath":"/rest/all","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerGroupConfigV1","description":"Interface for system configuration operations for customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogTierPriceStorageV1","description":"Tier prices storage."},{"name":"catalogBasePriceStorageV1","description":"Base prices storage."},{"name":"catalogCostStorageV1","description":"Product cost storage."},{"name":"catalogSpecialPriceStorageV1","description":"Special price storage presents efficient price API and is used to retrieve, update or delete special prices."},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogCategoryListV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":"Interface ProductWebsiteLinkRepositoryInterface"},{"name":"catalogProductRenderListV1","description":"Interface which provides product renders information for products"},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteGuestShipmentEstimationV1","description":"Interface GuestShipmentEstimationInterface"},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"requisitionListRequisitionListRepositoryV1","description":"Interface RequisitionListRepositoryInterface"},{"name":"searchV1","description":"Search API for all requests"},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesRefundInvoiceV1","description":"Interface RefundInvoiceInterface"},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesRefundOrderV1","description":"Interface RefundOrderInterface"},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesShipOrderV1","description":"Class ShipOrderInterface"},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"salesInvoiceOrderV1","description":"Class InvoiceOrderInterface"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"checkoutAgreementsCheckoutAgreementsListV1","description":"Interface for retrieving list of checkout agreements. Extended variation of CheckoutAgreementsRepositoryInterface::getList with possibility to get results according search filters without predefined limitations."},{"name":"companyCompanyRepositoryV1","description":"A repository interface for company entity that provides basic CRUD operations."},{"name":"companyTeamRepositoryV1","description":"Interface for basic CRUD operations for team entity."},{"name":"companyCompanyHierarchyV1","description":"Interface for working with company hierarchy."},{"name":"companyRoleRepositoryV1","description":"A repository interface for role entity that provides basic CRUD operations."},{"name":"companyAclV1","description":"Access control list interface."},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"analyticsLinkProviderV1","description":"Provides link to file with collected report data."},{"name":"customerBalanceBalanceManagementV1","description":"Customer balance(store credit) operations"},{"name":"giftCardAccountGiftCardAccountManagementV1","description":"Interface GiftCardAccountManagementInterface"},{"name":"giftCardAccountGuestGiftCardAccountManagementV1","description":"Interface GuestGiftCardAccountManagementInterface"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"},{"name":"giftRegistryShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"giftRegistryGuestCartShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"giftWrappingWrappingRepositoryV1","description":"Interface WrappingRepositoryInterface"},{"name":"inventoryApiSourceRepositoryV1","description":"In Magento 2 Repository considered as an implementation of Facade pattern which provides a simplified interface to a larger body of code responsible for Domain Entity management The main intention is to make API more readable and reduce dependencies of business logic code on the inner workings of a module, since most code uses the facade, thus allowing more flexibility in developing the system Along with this such approach helps to segregate two responsibilities: 1. Repository now could be considered as an API - Interface for usage (calling) in the business logic 2. Separate class-commands to which Repository proxies initial call (like, Get Save GetList Delete) could be considered as SPI - Interfaces that you should extend and implement to customize current behaviour There is no delete method. It is related to that Source can't be deleted due to we don't want miss data related to Sources (like as order information). But Source can be disabled Used fully qualified namespaces in annotations for proper work of WebApi request parser"},{"name":"inventoryApiGetSourcesAssignedToStockOrderedByPriorityV1","description":"Retrieve sources related to current stock ordered by priority Used fully qualified namespaces in annotations for proper work of WebApi request parser"},{"name":"inventoryApiStockRepositoryV1","description":"In Magento 2 Repository considered as an implementation of Facade pattern which provides a simplified interface to a larger body of code responsible for Domain Entity management The main intention is to make API more readable and reduce dependencies of business logic code on the inner workings of a module, since most code uses the facade, thus allowing more flexibility in developing the system Along with this such approach helps to segregate two responsibilities: 1. Repository now could be considered as an API - Interface for usage (calling) in the business logic 2. Separate class-commands to which Repository proxies initial call (like, Get Save GetList Delete) could be considered as SPI - Interfaces that you should extend and implement to customize current behaviour Used fully qualified namespaces in annotations for proper work of WebApi request parser"},{"name":"inventoryApiGetStockSourceLinksV1","description":"Find StockSourceLink list by SearchCriteria API Used fully qualified namespaces in annotations for proper work of WebApi request parser"},{"name":"inventoryApiStockSourceLinksSaveV1","description":"Service method for stock source links save multiple Performance efficient API Used fully qualified namespaces in annotations for proper work of WebApi request parser"},{"name":"inventoryApiStockSourceLinksDeleteV1","description":"Service method for stock source links delete multiple Performance efficient API Used fully qualified namespaces in annotations for proper work of WebApi request parser"},{"name":"inventoryApiSourceItemRepositoryV1","description":"In Magento 2 Repository considered as an implementation of Facade pattern which provides a simplified interface to a larger body of code responsible for Domain Entity management The main intention is to make API more readable and reduce dependencies of business logic code on the inner workings of a module, since most code uses the facade, thus allowing more flexibility in developing the system Along with this such approach helps to segregate two responsibilities: 1. Repository now could be considered as an API - Interface for usage (calling) in the business logic 2. Separate class-commands to which Repository proxies initial call (like, Get Save GetList Delete) could be considered as SPI - Interfaces that you should extend and implement to customize current behaviour The method save is absent, due to different semantic (save multiple)"},{"name":"inventoryApiSourceItemsSaveV1","description":"Service method for source items save multiple Performance efficient API Used fully qualified namespaces in annotations for proper work of WebApi request parser"},{"name":"inventoryApiSourceItemsDeleteV1","description":"Service method for source items delete multiple Performance efficient API Used fully qualified namespaces in annotations for proper work of WebApi request parser"},{"name":"inventoryCatalogApiBulkSourceAssignV1","description":"Perform bulk product source assignment"},{"name":"inventoryCatalogApiBulkSourceUnassignV1","description":"Perform bulk product source un-assignment"},{"name":"inventoryCatalogApiBulkInventoryTransferV1","description":"Perform bulk product inventory transfer"},{"name":"inventoryLowQuantityNotificationApiGetSourceItemConfigurationV1","description":"Get the source item configuration Firstly try to load Source Item configuration if configuration isn't exist then load global configuration value Used fully qualified namespaces in annotations for proper work of WebApi request parser"},{"name":"inventoryLowQuantityNotificationApiSourceItemConfigurationsSaveV1","description":"Save the source item configuration Used fully qualified namespaces in annotations for proper work of WebApi request parser"},{"name":"inventoryLowQuantityNotificationApiDeleteSourceItemConfigurationV1","description":"Delete the source item configuration"},{"name":"inventorySalesApiGetProductSalableQtyV1","description":"Service which returns Quantity of products available to be sold by Product SKU and Stock Id. This service calculates the salable qty taking into account existing reservations for given sku and stock id and subtracting min qty (a.k.a. \"Out-of-Stock Threshold\")"},{"name":"inventorySalesApiIsProductSalableV1","description":"Service which detects whether Product is salable for a given Stock (stock data + reservations)"},{"name":"inventorySourceSelectionApiGetSourceSelectionAlgorithmListV1","description":"Returns the list of Data Interfaces which represent registered SSA in the system"},{"name":"inventorySourceSelectionApiSourceSelectionServiceV1","description":"Returns source selection algorithm result for given Inventory Request"},{"name":"negotiableQuoteNegotiableQuoteManagementV1","description":"Interface for managing quotes."},{"name":"negotiableQuoteNegotiableQuotePriceManagementV1","description":"Interface for updating quote prices in case price changes occur in system."},{"name":"negotiableQuoteAttachmentContentManagementV1","description":"Interface for retrieving the list of negotiable quotes attachments."},{"name":"negotiableQuoteCommentLocatorV1","description":"Interface for load quote comments with attachment."},{"name":"negotiableQuoteNegotiableQuoteShippingManagementV1","description":"Interface for add and update negotiable quote shipping method."},{"name":"negotiableQuotePaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"negotiableQuoteShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"negotiableQuoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"negotiableQuoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"negotiableQuoteNegotiableCartRepositoryV1","description":"Interface is intended to be used in webapi only. For other cases CartRepositoryInterface should be used."},{"name":"negotiableQuoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"negotiableQuoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"negotiableQuoteCouponManagementV1","description":"Coupon management service interface."},{"name":"negotiableQuoteGiftCardAccountManagementV1","description":"Interface GiftCardAccountManagementInterface"},{"name":"sharedCatalogSharedCatalogRepositoryV1","description":""},{"name":"sharedCatalogCompanyManagementV1","description":"Shared catalog companies actions."},{"name":"sharedCatalogProductManagementV1","description":"Shared catalog products actions."},{"name":"sharedCatalogCategoryManagementV1","description":"Shared catalog products actions."},{"name":"rewardRewardManagementV1","description":"Interface RewardManagementInterface"},{"name":"rmaTrackManagementV1","description":"Interface TrackManagementInterface"},{"name":"rmaRmaRepositoryV1","description":"Interface RmaRepositoryInterface"},{"name":"rmaCommentManagementV1","description":"Interface CommentRepositoryInterface"},{"name":"rmaRmaManagementV1","description":"Interface RmaManagementInterface"},{"name":"rmaRmaAttributesManagementV1","description":"Interface RmaAttributesManagementInterface"},{"name":"companyCreditCreditLimitRepositoryV1","description":"Interface for credit limit repository for CRUD operations."},{"name":"companyCreditCreditLimitManagementV1","description":"Credit Limit management interface."},{"name":"companyCreditCreditBalanceManagementV1","description":"Interface for management decrease and increase credit balance operations."},{"name":"companyCreditCreditHistoryManagementV1","description":"Update credit history log and retrieve history which match a specified criteria."},{"name":"asynchronousOperationsBulkStatusV1","description":"Interface BulkStatusInterface. Bulk summary data with list of operations items short data."},{"name":"asynchronousOperationsOperationRepositoryV1","description":"Bulk operation item repository interface. An bulk is a group of queue messages. An bulk operation item is a queue message."},{"name":"worldpayGuestPaymentInformationManagementProxyV1","description":"Interface GuestPaymentInformationManagementProxyInterface"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"customerGroupRepositoryV1SavePostBody","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{id}":{"put":{"tags":["customerCustomerGroupConfigV1"],"description":"Set system default customer group.","operationId":"customerCustomerGroupConfigV1SetDefaultCustomerGroupPut","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by Customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by Customer ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"customerCustomerRepositoryV1SavePutBody","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by Customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"customerAccountManagementV1CreateAccountPostBody","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"customerAccountManagementV1ActivateByIdPutBody","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"customerAccountManagementV1ActivatePutBody","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"customerAccountManagementV1ChangePasswordByIdPutBody","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"customerAccountManagementV1InitiatePasswordResetPutBody","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/resetPassword":{"post":{"tags":["customerAccountManagementV1"],"description":"Reset customer password.","operationId":"customerAccountManagementV1ResetPasswordPost","parameters":[{"name":"customerAccountManagementV1ResetPasswordPostBody","in":"body","schema":{"required":["email","resetToken","newPassword"],"properties":{"email":{"type":"string"},"resetToken":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"customerAccountManagementV1ResendConfirmationPostBody","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"customerAccountManagementV1ValidatePutBody","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"cmsPageRepositoryV1SavePostBody","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"cmsBlockRepositoryV1SavePostBody","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"catalogProductRepositoryV1SavePostBody","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"catalogProductAttributeRepositoryV1SavePostBody","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"catalogAttributeSetManagementV1CreatePostBody","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"catalogProductAttributeGroupRepositoryV1SavePostBody","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices-information":{"post":{"tags":["catalogTierPriceStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogTierPriceStorageV1GetPost","parameters":[{"name":"catalogTierPriceStorageV1GetPostBody","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices":{"post":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"catalogTierPriceStorageV1UpdatePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"catalogTierPriceStorageV1ReplacePutBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/tier-prices-delete":{"post":{"tags":["catalogTierPriceStorageV1"],"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","parameters":[{"name":"catalogTierPriceStorageV1DeletePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-tier-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/base-prices-information":{"post":{"tags":["catalogBasePriceStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogBasePriceStorageV1GetPost","parameters":[{"name":"catalogBasePriceStorageV1GetPostBody","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-base-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/base-prices":{"post":{"tags":["catalogBasePriceStorageV1"],"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","parameters":[{"name":"catalogBasePriceStorageV1UpdatePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-base-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost-information":{"post":{"tags":["catalogCostStorageV1"],"description":"Return product prices. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogCostStorageV1GetPost","parameters":[{"name":"catalogCostStorageV1GetPostBody","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-cost-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost":{"post":{"tags":["catalogCostStorageV1"],"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","parameters":[{"name":"catalogCostStorageV1UpdatePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-cost-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/cost-delete":{"post":{"tags":["catalogCostStorageV1"],"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","parameters":[{"name":"catalogCostStorageV1DeletePostBody","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will return True if deleted."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price-information":{"post":{"tags":["catalogSpecialPriceStorageV1"],"description":"Return product's special price. In case of at least one of skus is not found exception will be thrown.","operationId":"catalogSpecialPriceStorageV1GetPost","parameters":[{"name":"catalogSpecialPriceStorageV1GetPostBody","in":"body","schema":{"required":["skus"],"properties":{"skus":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price":{"post":{"tags":["catalogSpecialPriceStorageV1"],"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","parameters":[{"name":"catalogSpecialPriceStorageV1UpdatePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/special-price-delete":{"post":{"tags":["catalogSpecialPriceStorageV1"],"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","parameters":[{"name":"catalogSpecialPriceStorageV1DeletePostBody","in":"body","schema":{"required":["prices"],"properties":{"prices":{"type":"array","items":{"$ref":"#/definitions/catalog-data-special-price-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-price-update-result-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"catalogCategoryRepositoryV1SavePostBody","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/list":{"get":{"tags":["catalogCategoryListV1"],"description":"Get category list","operationId":"catalogCategoryListV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"catalogProductCustomOptionRepositoryV1SavePostBody","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products-render-info":{"get":{"tags":["catalogProductRenderListV1"],"description":"Collect and retrieve the list of product render info This info contains raw prices and formated prices, product name, stock status, store_id, etc","operationId":"catalogProductRenderListV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."},{"name":"storeId","in":"query","type":"integer","required":true},{"name":"currencyCode","in":"query","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-render-search-results-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"bundleProductOptionManagementV1SavePostBody","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"put":{"tags":["quoteCartRepositoryV1"],"description":"Save quote","operationId":"quoteCartRepositoryV1SavePut","parameters":[{"name":"quoteCartRepositoryV1SavePutBody","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer if customer does not have a cart yet.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"new cart ID if customer did not have a cart or ID of the existing cart otherwise."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer if customer does not have a cart yet.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"new cart ID if customer did not have a cart or ID of the existing cart otherwise."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"quoteCartManagementV1PlaceOrderPutBody","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"quoteShippingMethodManagementV1EstimateByAddressIdPostBody","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"quoteShipmentEstimationV1EstimateByExtendedAddressPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/items":{"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"quoteCartItemRepositoryV1SavePostBody","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteGuestCartItemRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"quotePaymentMethodManagementV1SetPutBody","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"quoteBillingAddressManagementV1AssignPostBody","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/requisition_lists":{"post":{"tags":["requisitionListRequisitionListRepositoryV1"],"description":"Save Requisition List","operationId":"requisitionListRequisitionListRepositoryV1SavePost","parameters":[{"name":"requisitionListRequisitionListRepositoryV1SavePostBody","in":"body","schema":{"required":["requisitionList"],"properties":{"requisitionList":{"$ref":"#/definitions/requisition-list-data-requisition-list-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/requisition-list-data-requisition-list-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/create":{"put":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePut","parameters":[{"name":"salesOrderRepositoryV1SavePutBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/":{"post":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePost","parameters":[{"name":"salesOrderRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"salesInvoiceRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"salesInvoiceCommentRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoice/{invoiceId}/refund":{"post":{"tags":["salesRefundInvoiceV1"],"description":"Create refund for invoice","operationId":"salesRefundInvoiceV1ExecutePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/refund":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Prepare creditmemo to refund and save it.","operationId":"salesCreditmemoManagementV1RefundPost","parameters":[{"name":"salesCreditmemoManagementV1RefundPostBody","in":"body","schema":{"required":["creditmemo"],"properties":{"creditmemo":{"$ref":"#/definitions/sales-data-creditmemo-interface"},"offlineRequested":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"salesCreditmemoRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/refund":{"post":{"tags":["salesRefundOrderV1"],"description":"Create offline refund for order","operationId":"salesRefundOrderV1ExecutePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"salesShipmentRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"salesShipmentTrackRepositoryV1SavePostBody","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/ship":{"post":{"tags":["salesShipOrderV1"],"description":"Creates new Shipment for given Order.","operationId":"salesShipOrderV1ExecutePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Id of created Shipment."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/order/{orderId}/invoice":{"post":{"tags":["salesInvoiceOrderV1"],"description":"","operationId":"salesInvoiceOrderV1ExecutePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"salesRuleRuleRepositoryV1SavePostBody","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"salesRuleCouponRepositoryV1SavePostBody","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"salesRuleCouponManagementV1GeneratePostBody","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"salesRuleCouponManagementV1DeleteByIdsPostBody","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"salesRuleCouponManagementV1DeleteByCodesPostBody","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"checkoutShippingInformationManagementV1SaveAddressInformationPostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"checkoutTotalsInformationManagementV1CalculatePostBody","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence/list":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsListV1"],"description":"List of checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsListV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/":{"get":{"tags":["companyCompanyRepositoryV1"],"description":"Returns the list of companies. The list is an array of objects, and detailed information about item attributes might not be included.","operationId":"companyCompanyRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["companyCompanyRepositoryV1"],"description":"Create or update a company account.","operationId":"companyCompanyRepositoryV1SavePost","parameters":[{"name":"companyCompanyRepositoryV1SavePostBody","in":"body","schema":{"required":["company"],"properties":{"company":{"$ref":"#/definitions/company-data-company-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/{companyId}":{"get":{"tags":["companyCompanyRepositoryV1"],"description":"Returns company details.","operationId":"companyCompanyRepositoryV1GetGet","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyCompanyRepositoryV1"],"description":"Delete a company. Customers belonging to a company are not deleted with this request.","operationId":"companyCompanyRepositoryV1DeleteByIdDelete","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["companyCompanyRepositoryV1"],"description":"Create or update a company account.","operationId":"companyCompanyRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-company-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/":{"get":{"tags":["companyTeamRepositoryV1"],"description":"Returns the list of teams for the specified search criteria (team name or description).","operationId":"companyTeamRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-team-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/{teamId}":{"get":{"tags":["companyTeamRepositoryV1"],"description":"Returns data for a team in the company, by entity id.","operationId":"companyTeamRepositoryV1GetGet","parameters":[{"name":"teamId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-team-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyTeamRepositoryV1"],"description":"Delete a team from the company structure.","operationId":"companyTeamRepositoryV1DeleteByIdDelete","parameters":[{"name":"teamId","in":"path","type":"integer","required":true}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["companyTeamRepositoryV1"],"description":"Update a team in the company structure.","operationId":"companyTeamRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/team/{companyId}":{"post":{"tags":["companyTeamRepositoryV1"],"description":"Create a team in the company structure.","operationId":"companyTeamRepositoryV1CreatePost","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"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/hierarchy/{id}":{"get":{"tags":["companyCompanyHierarchyV1"],"description":"Returns the list of teams and company users in the company structure.","operationId":"companyCompanyHierarchyV1GetCompanyHierarchyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/company-data-hierarchy-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/hierarchy/move/{id}":{"put":{"tags":["companyCompanyHierarchyV1"],"description":"Moves teams and users within the company structure.","operationId":"companyCompanyHierarchyV1MoveNodePut","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"companyCompanyHierarchyV1MoveNodePutBody","in":"body","schema":{"required":["newParentId"],"properties":{"newParentId":{"type":"integer"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/":{"get":{"tags":["companyRoleRepositoryV1"],"description":"Returns the list of roles and permissions for a specified company.","operationId":"companyRoleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["companyRoleRepositoryV1"],"description":"Create or update a role for a selected company.","operationId":"companyRoleRepositoryV1SavePost","parameters":[{"name":"companyRoleRepositoryV1SavePostBody","in":"body","schema":{"required":["role"],"properties":{"role":{"$ref":"#/definitions/company-data-role-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{roleId}":{"get":{"tags":["companyRoleRepositoryV1"],"description":"Returns the list of permissions for a specified role.","operationId":"companyRoleRepositoryV1GetGet","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["companyRoleRepositoryV1"],"description":"Delete a role.","operationId":"companyRoleRepositoryV1DeleteDelete","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{id}":{"put":{"tags":["companyRoleRepositoryV1"],"description":"Create or update a role for a selected company.","operationId":"companyRoleRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-data-role-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/assignRoles":{"put":{"tags":["companyAclV1"],"description":"Change a role for a company user.","operationId":"companyAclV1AssignRolesPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/company/role/{roleId}/users":{"get":{"tags":["companyAclV1"],"description":"View the list of company users assigned to a specified role.","operationId":"companyAclV1GetUsersByRoleIdGet","parameters":[{"name":"roleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-customer-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"integrationAdminTokenServiceV1CreateAdminAccessTokenPostBody","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPostBody","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Configurable product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"configurableProductLinkManagementV1AddChildPostBody","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/analytics/link":{"get":{"tags":["analyticsLinkProviderV1"],"description":"","operationId":"analyticsLinkProviderV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/analytics-data-link-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/balance/apply":{"post":{"tags":["customerBalanceBalanceManagementV1"],"description":"Apply store credit","operationId":"customerBalanceBalanceManagementV1ApplyPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/giftCards":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Return GiftCard Account cards","operationId":"giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards":{"put":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/giftCards":{"post":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost","parameters":[{"name":"giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPostBody","in":"body","schema":{"required":["giftCardAccountData"],"properties":{"giftCardAccountData":{"$ref":"#/definitions/gift-card-account-data-gift-card-account-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/giftCards":{"post":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/guest-carts/{cartId}/checkGiftCard/{giftCardCode}":{"get":{"tags":["giftCardAccountGuestGiftCardAccountManagementV1"],"description":"","operationId":"giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"taxTaxRateRepositoryV1SavePostBody","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"taxTaxRateRepositoryV1SavePutBody","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"taxTaxRuleRepositoryV1SavePostBody","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"taxTaxRuleRepositoryV1SavePutBody","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"taxTaxClassRepositoryV1SavePostBody","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"giftMessageCartRepositoryV1SavePostBody","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/giftregistry/mine/estimate-shipping-methods":{"post":{"tags":["giftRegistryShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost","parameters":[{"name":"giftRegistryShippingMethodManagementV1EstimateByRegistryIdPostBody","in":"body","schema":{"required":["registryId"],"properties":{"registryId":{"type":"integer","description":"The estimate registry id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-giftregistry/{cartId}/estimate-shipping-methods":{"post":{"tags":["giftRegistryGuestCartShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{id}":{"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return data object for specified wrapping ID and store.","operationId":"giftWrappingWrappingRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Delete gift wrapping","operationId":"giftWrappingWrappingRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings":{"post":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePost","parameters":[{"name":"giftWrappingWrappingRepositoryV1SavePostBody","in":"body","schema":{"required":["data"],"properties":{"data":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Return list of gift wrapping data objects based on search criteria","operationId":"giftWrappingWrappingRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/gift-wrappings/{wrappingId}":{"put":{"tags":["giftWrappingWrappingRepositoryV1"],"description":"Create/Update new gift wrapping with data object values","operationId":"giftWrappingWrappingRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/sources":{"get":{"tags":["inventoryApiSourceRepositoryV1"],"description":"Find Sources by SearchCriteria SearchCriteria is not required because load all stocks is useful case","operationId":"inventoryApiSourceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/inventory-api-data-source-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["inventoryApiSourceRepositoryV1"],"description":"Save Source data","operationId":"inventoryApiSourceRepositoryV1SavePost","parameters":[{"name":"inventoryApiSourceRepositoryV1SavePostBody","in":"body","schema":{"required":["source"],"properties":{"source":{"$ref":"#/definitions/inventory-api-data-source-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/sources/{sourceCode}":{"get":{"tags":["inventoryApiSourceRepositoryV1"],"description":"Get Source data by given code. If you want to create plugin on get method, also you need to create separate plugin on getList method, because entity loading way is different for these methods","operationId":"inventoryApiSourceRepositoryV1GetGet","parameters":[{"name":"sourceCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/inventory-api-data-source-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["inventoryApiSourceRepositoryV1"],"description":"Save Source data","operationId":"inventoryApiSourceRepositoryV1SavePut","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"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/get-sources-assigned-to-stock-ordered-by-priority/{stockId}":{"get":{"tags":["inventoryApiGetSourcesAssignedToStockOrderedByPriorityV1"],"description":"Get Sources assigned to Stock ordered by priority If Stock with given id doesn't exist then return an empty array","operationId":"inventoryApiGetSourcesAssignedToStockOrderedByPriorityV1ExecuteGet","parameters":[{"name":"stockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/inventory-api-data-source-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/stocks":{"get":{"tags":["inventoryApiStockRepositoryV1"],"description":"Find Stocks by given SearchCriteria SearchCriteria is not required because load all stocks is useful case","operationId":"inventoryApiStockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/inventory-api-data-stock-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["inventoryApiStockRepositoryV1"],"description":"Save Stock data","operationId":"inventoryApiStockRepositoryV1SavePost","parameters":[{"name":"inventoryApiStockRepositoryV1SavePostBody","in":"body","schema":{"required":["stock"],"properties":{"stock":{"$ref":"#/definitions/inventory-api-data-stock-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/stocks/{stockId}":{"get":{"tags":["inventoryApiStockRepositoryV1"],"description":"Get Stock data by given stockId. If you want to create plugin on get method, also you need to create separate plugin on getList method, because entity loading way is different for these methods","operationId":"inventoryApiStockRepositoryV1GetGet","parameters":[{"name":"stockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/inventory-api-data-stock-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["inventoryApiStockRepositoryV1"],"description":"Delete the Stock data by stockId. If stock is not found do nothing","operationId":"inventoryApiStockRepositoryV1DeleteByIdDelete","parameters":[{"name":"stockId","in":"path","type":"integer","required":true}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["inventoryApiStockRepositoryV1"],"description":"Save Stock data","operationId":"inventoryApiStockRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/stock-source-links":{"get":{"tags":["inventoryApiGetStockSourceLinksV1"],"description":"Find StockSourceLink list by given SearchCriteria","operationId":"inventoryApiGetStockSourceLinksV1ExecuteGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/inventory-api-data-stock-source-link-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["inventoryApiStockSourceLinksSaveV1"],"description":"Save StockSourceLink list data","operationId":"inventoryApiStockSourceLinksSaveV1ExecutePost","parameters":[{"name":"inventoryApiStockSourceLinksSaveV1ExecutePostBody","in":"body","schema":{"required":["links"],"properties":{"links":{"type":"array","items":{"$ref":"#/definitions/inventory-api-data-stock-source-link-interface"}}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/stock-source-links-delete":{"post":{"tags":["inventoryApiStockSourceLinksDeleteV1"],"description":"Remove StockSourceLink list list","operationId":"inventoryApiStockSourceLinksDeleteV1ExecutePost","parameters":[{"name":"inventoryApiStockSourceLinksDeleteV1ExecutePostBody","in":"body","schema":{"required":["links"],"properties":{"links":{"type":"array","items":{"$ref":"#/definitions/inventory-api-data-stock-source-link-interface"}}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/source-items":{"get":{"tags":["inventoryApiSourceItemRepositoryV1"],"description":"Find SourceItems by SearchCriteria We need to have this method for direct work with SourceItems because this object contains additional data like as qty, status (for example can be searchable by additional field)","operationId":"inventoryApiSourceItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/inventory-api-data-source-item-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["inventoryApiSourceItemsSaveV1"],"description":"Save Multiple Source item data","operationId":"inventoryApiSourceItemsSaveV1ExecutePost","parameters":[{"name":"inventoryApiSourceItemsSaveV1ExecutePostBody","in":"body","schema":{"required":["sourceItems"],"properties":{"sourceItems":{"type":"array","items":{"$ref":"#/definitions/inventory-api-data-source-item-interface"}}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/source-items-delete":{"post":{"tags":["inventoryApiSourceItemsDeleteV1"],"description":"Delete Multiple Source item data","operationId":"inventoryApiSourceItemsDeleteV1ExecutePost","parameters":[{"name":"inventoryApiSourceItemsDeleteV1ExecutePostBody","in":"body","schema":{"required":["sourceItems"],"properties":{"sourceItems":{"type":"array","items":{"$ref":"#/definitions/inventory-api-data-source-item-interface"}}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/bulk-product-source-assign":{"post":{"tags":["inventoryCatalogApiBulkSourceAssignV1"],"description":"Run mass product to source assignment","operationId":"inventoryCatalogApiBulkSourceAssignV1ExecutePost","parameters":[{"name":"inventoryCatalogApiBulkSourceAssignV1ExecutePostBody","in":"body","schema":{"required":["skus","sourceCodes"],"properties":{"skus":{"type":"array","items":{"type":"string"}},"sourceCodes":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/bulk-product-source-unassign":{"post":{"tags":["inventoryCatalogApiBulkSourceUnassignV1"],"description":"Run mass product to source un-assignment","operationId":"inventoryCatalogApiBulkSourceUnassignV1ExecutePost","parameters":[{"name":"inventoryCatalogApiBulkSourceUnassignV1ExecutePostBody","in":"body","schema":{"required":["skus","sourceCodes"],"properties":{"skus":{"type":"array","items":{"type":"string"}},"sourceCodes":{"type":"array","items":{"type":"string"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/bulk-product-source-transfer":{"post":{"tags":["inventoryCatalogApiBulkInventoryTransferV1"],"description":"Run bulk inventory transfer","operationId":"inventoryCatalogApiBulkInventoryTransferV1ExecutePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/low-quantity-notification/{sourceCode}/{sku}":{"get":{"tags":["inventoryLowQuantityNotificationApiGetSourceItemConfigurationV1"],"description":"Get the source item configuration","operationId":"inventoryLowQuantityNotificationApiGetSourceItemConfigurationV1ExecuteGet","parameters":[{"name":"sourceCode","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/inventory-low-quantity-notification-api-data-source-item-configuration-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/low-quantity-notification":{"post":{"tags":["inventoryLowQuantityNotificationApiSourceItemConfigurationsSaveV1"],"description":"","operationId":"inventoryLowQuantityNotificationApiSourceItemConfigurationsSaveV1ExecutePost","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"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["inventoryLowQuantityNotificationApiDeleteSourceItemConfigurationV1"],"description":"","operationId":"inventoryLowQuantityNotificationApiDeleteSourceItemConfigurationV1ExecuteDelete","parameters":[{"name":"inventoryLowQuantityNotificationApiDeleteSourceItemConfigurationV1ExecuteDeleteBody","in":"body","schema":{"required":["sourceCode","sku"],"properties":{"sourceCode":{"type":"string"},"sku":{"type":"string"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/get-product-salable-quantity/{sku}/{stockId}":{"get":{"tags":["inventorySalesApiGetProductSalableQtyV1"],"description":"Get Product Quantity for given SKU and Stock","operationId":"inventorySalesApiGetProductSalableQtyV1ExecuteGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"stockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"number"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/is-product-salable/{sku}/{stockId}":{"get":{"tags":["inventorySalesApiIsProductSalableV1"],"description":"Get is product in salable for given SKU in a given Stock","operationId":"inventorySalesApiIsProductSalableV1ExecuteGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"stockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/source-selection-algorithm-list":{"get":{"tags":["inventorySourceSelectionApiGetSourceSelectionAlgorithmListV1"],"description":"","operationId":"inventorySourceSelectionApiGetSourceSelectionAlgorithmListV1ExecuteGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/inventory-source-selection-api-data-source-selection-algorithm-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/inventory/source-selection-algorithm-result":{"post":{"tags":["inventorySourceSelectionApiSourceSelectionServiceV1"],"description":"","operationId":"inventorySourceSelectionApiSourceSelectionServiceV1ExecutePost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/inventory-source-selection-api-data-source-selection-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/request":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/submitToCustomer":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/decline":{"post":{"tags":["negotiableQuoteNegotiableQuoteManagementV1"],"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","parameters":[{"name":"negotiableQuoteNegotiableQuoteManagementV1DeclinePostBody","in":"body","schema":{"required":["quoteId","reason"],"properties":{"quoteId":{"type":"integer"},"reason":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/pricesUpdated":{"post":{"tags":["negotiableQuoteNegotiableQuotePriceManagementV1"],"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","parameters":[{"name":"negotiableQuoteNegotiableQuotePriceManagementV1PricesUpdatedPostBody","in":"body","schema":{"required":["quoteIds"],"properties":{"quoteIds":{"type":"array","items":{"type":"integer"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/attachmentContent":{"get":{"tags":["negotiableQuoteAttachmentContentManagementV1"],"description":"Returns content for one or more files attached on the quote comment.","operationId":"negotiableQuoteAttachmentContentManagementV1GetGet","parameters":[{"name":"attachmentIds","in":"query","type":"array","items":{"type":"integer"},"required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/negotiable-quote-data-attachment-content-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}/comments":{"get":{"tags":["negotiableQuoteCommentLocatorV1"],"description":"Returns comments for a specified negotiable quote.","operationId":"negotiableQuoteCommentLocatorV1GetListForQuoteGet","parameters":[{"name":"quoteId","in":"path","type":"integer","required":true,"description":"Negotiable Quote ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of quote comments.","items":{"$ref":"#/definitions/negotiable-quote-data-comment-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}/shippingMethod":{"put":{"tags":["negotiableQuoteNegotiableQuoteShippingManagementV1"],"description":"Updates the shipping method on a negotiable quote.","operationId":"negotiableQuoteNegotiableQuoteShippingManagementV1SetShippingMethodPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/payment-information":{"post":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Get payment information","operationId":"negotiableQuotePaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/set-payment-information":{"post":{"tags":["negotiableQuotePaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"negotiableQuotePaymentInformationManagementV1SavePaymentInformationPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/shipping-information":{"post":{"tags":["negotiableQuoteShippingInformationManagementV1"],"description":"","operationId":"negotiableQuoteShippingInformationManagementV1SaveAddressInformationPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["negotiableQuoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"negotiableQuoteShipmentEstimationV1EstimateByExtendedAddressPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["negotiableQuoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"negotiableQuoteShippingMethodManagementV1EstimateByAddressIdPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiableQuote/{quoteId}":{"put":{"tags":["negotiableQuoteNegotiableCartRepositoryV1"],"description":"Save quote","operationId":"negotiableQuoteNegotiableCartRepositoryV1SavePut","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"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/billing-address":{"get":{"tags":["negotiableQuoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"negotiableQuoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["negotiableQuoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"negotiableQuoteBillingAddressManagementV1AssignPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/totals":{"get":{"tags":["negotiableQuoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"negotiableQuoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["negotiableQuoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"negotiableQuoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/coupons":{"delete":{"tags":["negotiableQuoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"negotiableQuoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/giftCards":{"post":{"tags":["negotiableQuoteGiftCardAccountManagementV1"],"description":"","operationId":"negotiableQuoteGiftCardAccountManagementV1SaveByQuoteIdPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/negotiable-carts/{cartId}/giftCards/{giftCardCode}":{"delete":{"tags":["negotiableQuoteGiftCardAccountManagementV1"],"description":"Remove GiftCard Account entity","operationId":"negotiableQuoteGiftCardAccountManagementV1DeleteByQuoteIdDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"giftCardCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}":{"get":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Return the following properties for the selected shared catalog: ID, Store Group ID, Name, Type, Description, Customer Group, Tax Class.","operationId":"sharedCatalogSharedCatalogRepositoryV1GetGet","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Delete a shared catalog by ID.","operationId":"sharedCatalogSharedCatalogRepositoryV1DeleteByIdDelete","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog":{"post":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Create or update Shared Catalog service.","operationId":"sharedCatalogSharedCatalogRepositoryV1SavePost","parameters":[{"name":"sharedCatalogSharedCatalogRepositoryV1SavePostBody","in":"body","schema":{"required":["sharedCatalog"],"properties":{"sharedCatalog":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}":{"put":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Create or update Shared Catalog service.","operationId":"sharedCatalogSharedCatalogRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/":{"get":{"tags":["sharedCatalogSharedCatalogRepositoryV1"],"description":"Return the list of shared catalogs and basic properties for each catalog.","operationId":"sharedCatalogSharedCatalogRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/shared-catalog-data-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/companies":{"get":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Return the list of company IDs for the companies assigned to the selected catalog.","operationId":"sharedCatalogCompanyManagementV1GetCompaniesGet","parameters":[{"name":"sharedCatalogId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/assignCompanies":{"post":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Assign companies to a shared catalog.","operationId":"sharedCatalogCompanyManagementV1AssignCompaniesPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{sharedCatalogId}/unassignCompanies":{"post":{"tags":["sharedCatalogCompanyManagementV1"],"description":"Unassign companies from a shared catalog.","operationId":"sharedCatalogCompanyManagementV1UnassignCompaniesPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/products":{"get":{"tags":["sharedCatalogProductManagementV1"],"description":"Return the list of product SKUs in the selected shared catalog.","operationId":"sharedCatalogProductManagementV1GetProductsGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/assignProducts":{"post":{"tags":["sharedCatalogProductManagementV1"],"description":"Add products into the shared catalog.","operationId":"sharedCatalogProductManagementV1AssignProductsPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/unassignProducts":{"post":{"tags":["sharedCatalogProductManagementV1"],"description":"Remove the specified products from the shared catalog.","operationId":"sharedCatalogProductManagementV1UnassignProductsPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/categories":{"get":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Return the list of categories in the selected shared catalog.","operationId":"sharedCatalogCategoryManagementV1GetCategoriesGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"integer"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/assignCategories":{"post":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Add categories into the shared catalog.","operationId":"sharedCatalogCategoryManagementV1AssignCategoriesPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/sharedCatalog/{id}/unassignCategories":{"post":{"tags":["sharedCatalogCategoryManagementV1"],"description":"Remove the specified categories from the shared catalog.","operationId":"sharedCatalogCategoryManagementV1UnassignCategoriesPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/reward/mine/use-reward":{"post":{"tags":["rewardRewardManagementV1"],"description":"Set reward points to quote","operationId":"rewardRewardManagementV1SetPost","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers":{"post":{"tags":["rmaTrackManagementV1"],"description":"Add track","operationId":"rmaTrackManagementV1AddTrackPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaTrackManagementV1"],"description":"Get track list","operationId":"rmaTrackManagementV1GetTracksGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-track-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/tracking-numbers/{trackId}":{"delete":{"tags":["rmaTrackManagementV1"],"description":"Remove track by id","operationId":"rmaTrackManagementV1RemoveTrackByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true},{"name":"trackId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/labels":{"get":{"tags":["rmaTrackManagementV1"],"description":"Get shipping label int the PDF format","operationId":"rmaTrackManagementV1GetShippingLabelPdfGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}":{"get":{"tags":["rmaRmaRepositoryV1"],"description":"Return data object for specified RMA id","operationId":"rmaRmaRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["rmaRmaRepositoryV1"],"description":"Delete RMA","operationId":"rmaRmaRepositoryV1DeleteDelete","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns/{id}/comments":{"post":{"tags":["rmaCommentManagementV1"],"description":"Add comment","operationId":"rmaCommentManagementV1AddCommentPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaCommentManagementV1"],"description":"Comments list","operationId":"rmaCommentManagementV1CommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returns":{"post":{"tags":["rmaRmaManagementV1"],"description":"Save RMA","operationId":"rmaRmaManagementV1SaveRmaPost","parameters":[{"name":"rmaRmaManagementV1SaveRmaPostBody","in":"body","schema":{"required":["rmaDataObject"],"properties":{"rmaDataObject":{"$ref":"#/definitions/rma-data-rma-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["rmaRmaManagementV1"],"description":"Return list of rma data objects based on search criteria","operationId":"rmaRmaManagementV1SearchGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/rma-data-rma-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/{attributeCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/form/{formCode}":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Retrieve all attributes filtered by form code","operationId":"rmaRmaAttributesManagementV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get all attribute metadata.","operationId":"rmaRmaAttributesManagementV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/returnsAttributeMetadata/custom":{"get":{"tags":["rmaRmaAttributesManagementV1"],"description":"Get custom attribute metadata for the given Data object's attribute set","operationId":"rmaRmaAttributesManagementV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataObjectClassName","in":"query","type":"string","description":"Data object class name","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/framework-metadata-object-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/":{"get":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Returns the list of credits for specified companies.","operationId":"companyCreditCreditLimitRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}":{"get":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Returns data on the credit limit for a specified credit limit ID.","operationId":"companyCreditCreditLimitRepositoryV1GetGet","parameters":[{"name":"creditId","in":"path","type":"integer","required":true},{"name":"reload","in":"query","type":"boolean","description":"[optional]","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{id}":{"put":{"tags":["companyCreditCreditLimitRepositoryV1"],"description":"Update the following company credit attributes: credit currency, credit limit and setting to exceed credit.","operationId":"companyCreditCreditLimitRepositoryV1SavePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/company/{companyId}":{"get":{"tags":["companyCreditCreditLimitManagementV1"],"description":"Returns data on the credit limit for a specified company.","operationId":"companyCreditCreditLimitManagementV1GetCreditByCompanyIdGet","parameters":[{"name":"companyId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-credit-limit-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}/increaseBalance":{"post":{"tags":["companyCreditCreditBalanceManagementV1"],"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","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/{creditId}/decreaseBalance":{"post":{"tags":["companyCreditCreditBalanceManagementV1"],"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","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/history":{"get":{"tags":["companyCreditCreditHistoryManagementV1"],"description":"Returns the credit history for one or more companies.","operationId":"companyCreditCreditHistoryManagementV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/company-credit-data-history-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/companyCredits/history/{historyId}":{"put":{"tags":["companyCreditCreditHistoryManagementV1"],"description":"Update the PO Number and/or comment for a Reimburse transaction.","operationId":"companyCreditCreditHistoryManagementV1UpdatePut","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bulk/{bulkUuid}/detailed-status":{"get":{"tags":["asynchronousOperationsBulkStatusV1"],"description":"Get Bulk summary data with list of operations items full data.","operationId":"asynchronousOperationsBulkStatusV1GetBulkDetailedStatusGet","parameters":[{"name":"bulkUuid","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/asynchronous-operations-data-detailed-bulk-operations-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bulk/{bulkUuid}/status":{"get":{"tags":["asynchronousOperationsBulkStatusV1"],"description":"Get Bulk summary data with list of operations items short data.","operationId":"asynchronousOperationsBulkStatusV1GetBulkShortStatusGet","parameters":[{"name":"bulkUuid","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/asynchronous-operations-data-bulk-operations-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bulk/{bulkUuid}/operation-status/{status}":{"get":{"tags":["asynchronousOperationsBulkStatusV1"],"description":"Get operations count by bulk uuid and status.","operationId":"asynchronousOperationsBulkStatusV1GetOperationsCountByBulkIdAndStatusGet","parameters":[{"name":"bulkUuid","in":"path","type":"string","required":true},{"name":"status","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bulk":{"get":{"tags":["asynchronousOperationsOperationRepositoryV1"],"description":"Lists the bulk operation items that match specified search criteria.","operationId":"asynchronousOperationsOperationRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][0][filters][0][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][0][filters][0][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][0][filters][0][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][0][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][0][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/asynchronous-operations-data-operation-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/worldpay-guest-carts/{cartId}/payment-information":{"post":{"tags":["worldpayGuestPaymentInformationManagementProxyV1"],"description":"Proxy handler for guest place order","operationId":"worldpayGuestPaymentInformationManagementProxyV1SavePaymentInformationAndPlaceOrderPost","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"website_id":{"type":"integer"},"store_group_id":{"type":"integer"},"is_active":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","website_id","store_group_id","is_active"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"website_id":{"type":"integer"},"root_category_id":{"type":"integer"},"default_store_id":{"type":"integer"},"name":{"type":"string"},"code":{"type":"string","description":"Group code."},"extension_attributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","website_id","root_category_id","default_store_id","name","code"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"default_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","default_group_id"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"website_id":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"base_currency_code":{"type":"string","description":"Base currency code"},"default_display_currency_code":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weight_unit":{"type":"string","description":"The unit of weight"},"base_url":{"type":"string","description":"Base URL for the store"},"base_link_url":{"type":"string","description":"Base link URL for the store"},"base_static_url":{"type":"string","description":"Base static URL for the store"},"base_media_url":{"type":"string","description":"Base media URL for the store"},"secure_base_url":{"type":"string","description":"Secure base URL for the store"},"secure_base_link_url":{"type":"string","description":"Secure base link URL for the store"},"secure_base_static_url":{"type":"string","description":"Secure base static URL for the store"},"secure_base_media_url":{"type":"string","description":"Secure base media URL for the store"},"extension_attributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","website_id","locale","base_currency_code","default_display_currency_code","timezone","weight_unit","base_url","base_link_url","base_static_url","base_media_url","secure_base_url","secure_base_link_url","secure_base_static_url","secure_base_media_url"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"base_currency_code":{"type":"string","description":"The base currency code for the store."},"base_currency_symbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"default_display_currency_code":{"type":"string","description":"The default display currency code for the store."},"default_display_currency_symbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"available_currency_codes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchange_rates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["base_currency_code","base_currency_symbol","default_display_currency_code","default_display_currency_symbol","available_currency_codes","exchange_rates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currency_to":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extension_attributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currency_to","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"two_letter_abbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"three_letter_abbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"full_name_locale":{"type":"string","description":"The country full name (in store locale) for the store."},"full_name_english":{"type":"string","description":"The country full name (in English) for the store."},"available_regions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","two_letter_abbreviation","three_letter_abbreviation","full_name_locale","full_name_english"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extension_attributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"Interface AttributeSetSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["filter_groups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"condition_type":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"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-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontend_input":{"type":"string","description":"HTML for input element."},"input_filter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"store_label":{"type":"string","description":"Label of the store."},"validation_rules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multiline_count":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"data_model":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontend_class":{"type":"string","description":"Class which is used to display the attribute on frontend."},"user_defined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sort_order":{"type":"integer","description":"Attributes sort order."},"frontend_label":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backend_type":{"type":"string","description":"Backend type."},"is_used_in_grid":{"type":"boolean","description":"It is used in customer grid"},"is_visible_in_grid":{"type":"boolean","description":"It is visible in customer grid"},"is_filterable_in_grid":{"type":"boolean","description":"It is filterable in customer grid"},"is_searchable_in_grid":{"type":"boolean","description":"It is searchable in customer grid"},"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["frontend_input","input_filter","store_label","validation_rules","multiline_count","visible","required","data_model","options","frontend_class","user_defined","sort_order","frontend_label","note","system","backend_type","attribute_code"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"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"}}},"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"},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"}},"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"}},"configurable_product_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"configurable_product_links":{"type":"array","items":{"type":"integer"}}}},"catalog-data-category-link-interface":{"type":"object","description":"","properties":{"position":{"type":"integer"},"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"},"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"},"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"},"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"},"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-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"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"},"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"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"Interface AttributeGroupSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-price-update-result-interface":{"type":"object","description":"Interface returned in case of incorrect price passed to efficient price API.","properties":{"message":{"type":"string","description":"Error message, that contains description of error occurred during price update."},"parameters":{"type":"array","description":"Parameters, that could be displayed in error message placeholders.","items":{"type":"string"}},"extension_attributes":{"$ref":"#/definitions/catalog-data-price-update-result-extension-interface"}},"required":["message","parameters"]},"catalog-data-price-update-result-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\PriceUpdateResultInterface"},"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":"","properties":{"id":{"type":"integer"},"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"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"path":{"type":"string"},"available_sort_by":{"type":"array","items":{"type":"string"}},"include_in_menu":{"type":"boolean"},"extension_attributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"product_count":{"type":"integer","description":"Product count"},"children_data":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parent_id","name","is_active","position","level","product_count","children_data"]},"catalog-data-category-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Categories","items":{"$ref":"#/definitions/catalog-data-category-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"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"]},"catalog-data-product-render-search-results-interface":{"type":"object","description":"Dto that holds render information about products","properties":{"items":{"type":"array","description":"List of products rendered information","items":{"$ref":"#/definitions/catalog-data-product-render-interface"}}},"required":["items"]},"catalog-data-product-render-interface":{"type":"object","description":"Represents Data Object which holds enough information to render product This information is put into part as Add To Cart or Add to Compare Data or Price Data","properties":{"add_to_cart_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"add_to_compare_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"price_info":{"$ref":"#/definitions/catalog-data-product-render-price-info-interface"},"images":{"type":"array","description":"Enough information, that needed to render image on front","items":{"$ref":"#/definitions/catalog-data-product-render-image-interface"}},"url":{"type":"string","description":"Product url"},"id":{"type":"integer","description":"Product identifier"},"name":{"type":"string","description":"Product name"},"type":{"type":"string","description":"Product type. Such as bundle, grouped, simple, etc..."},"is_salable":{"type":"string","description":"Information about product saleability (In Stock)"},"store_id":{"type":"integer","description":"Information about current store id or requested store id"},"currency_code":{"type":"string","description":"Current or desired currency code to product"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-extension-interface"}},"required":["add_to_cart_button","add_to_compare_button","price_info","images","url","id","name","type","is_salable","store_id","currency_code","extension_attributes"]},"catalog-data-product-render-button-interface":{"type":"object","description":"Button interface. This interface represents all manner of product buttons: add to cart, add to compare, etc... The buttons describes by this interface should have interaction with backend","properties":{"post_data":{"type":"string","description":"Post data"},"url":{"type":"string","description":"Url, needed to add product to cart"},"required_options":{"type":"boolean","description":"Flag whether a product has options or not"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-button-extension-interface"}},"required":["post_data","url","required_options"]},"catalog-data-product-render-button-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ButtonInterface"},"catalog-data-product-render-price-info-interface":{"type":"object","description":"Price interface.","properties":{"final_price":{"type":"number","description":"Final price"},"max_price":{"type":"number","description":"Max price of a product"},"max_regular_price":{"type":"number","description":"Max regular price"},"minimal_regular_price":{"type":"number","description":"Minimal regular price"},"special_price":{"type":"number","description":"Special price"},"minimal_price":{"type":"number"},"regular_price":{"type":"number","description":"Regular price"},"formatted_prices":{"$ref":"#/definitions/catalog-data-product-render-formatted-price-info-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-price-info-extension-interface"}},"required":["final_price","max_price","max_regular_price","minimal_regular_price","special_price","minimal_price","regular_price","formatted_prices"]},"catalog-data-product-render-formatted-price-info-interface":{"type":"object","description":"Formatted Price interface. Aggregate formatted html with price representations. E.g.: $9.00 Consider currency, rounding and html","properties":{"final_price":{"type":"string","description":"Html with final price"},"max_price":{"type":"string","description":"Max price of a product"},"minimal_price":{"type":"string","description":"The minimal price of the product or variation"},"max_regular_price":{"type":"string","description":"Max regular price"},"minimal_regular_price":{"type":"string","description":"Minimal regular price"},"special_price":{"type":"string","description":"Special price"},"regular_price":{"type":"string","description":"Price - is price of product without discounts and special price with taxes and fixed product tax"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-formatted-price-info-extension-interface"}},"required":["final_price","max_price","minimal_price","max_regular_price","minimal_regular_price","special_price","regular_price"]},"catalog-data-product-render-formatted-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\FormattedPriceInfoInterface"},"catalog-data-product-render-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\PriceInfoInterface","properties":{"msrp":{"$ref":"#/definitions/msrp-data-product-render-msrp-price-info-interface"},"tax_adjustments":{"$ref":"#/definitions/catalog-data-product-render-price-info-interface"},"weee_attributes":{"type":"array","items":{"$ref":"#/definitions/weee-data-product-render-weee-adjustment-attribute-interface"}},"weee_adjustment":{"type":"string"}}},"msrp-data-product-render-msrp-price-info-interface":{"type":"object","description":"Price interface.","properties":{"msrp_price":{"type":"string"},"is_applicable":{"type":"string"},"is_shown_price_on_gesture":{"type":"string"},"msrp_message":{"type":"string"},"explanation_message":{"type":"string"},"extension_attributes":{"$ref":"#/definitions/msrp-data-product-render-msrp-price-info-extension-interface"}},"required":["msrp_price","is_applicable","is_shown_price_on_gesture","msrp_message","explanation_message"]},"msrp-data-product-render-msrp-price-info-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Msrp\\Api\\Data\\ProductRender\\MsrpPriceInfoInterface"},"weee-data-product-render-weee-adjustment-attribute-interface":{"type":"object","description":"List of all weee attributes, their amounts, etc.., that product has","properties":{"amount":{"type":"string","description":"Weee attribute amount"},"tax_amount":{"type":"string","description":"Tax which is calculated to fixed product tax attribute"},"tax_amount_incl_tax":{"type":"string","description":"Tax amount of weee attribute"},"amount_excl_tax":{"type":"string","description":"Product amount exclude tax"},"attribute_code":{"type":"string","description":"Weee attribute code"},"extension_attributes":{"$ref":"#/definitions/weee-data-product-render-weee-adjustment-attribute-extension-interface"}},"required":["amount","tax_amount","tax_amount_incl_tax","amount_excl_tax","attribute_code","extension_attributes"]},"weee-data-product-render-weee-adjustment-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Weee\\Api\\Data\\ProductRender\\WeeeAdjustmentAttributeInterface"},"catalog-data-product-render-image-interface":{"type":"object","description":"Product Render image interface. Represents physical characteristics of image, that can be used in product listing or product view","properties":{"url":{"type":"string","description":"Image url"},"code":{"type":"string","description":"Image code"},"height":{"type":"number","description":"Image height"},"width":{"type":"number","description":"Image width in px"},"label":{"type":"string","description":"Image label"},"resized_width":{"type":"number","description":"Resize width"},"resized_height":{"type":"number","description":"Resize height"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-render-image-extension-interface"}},"required":["url","code","height","width","label","resized_width","resized_height"]},"catalog-data-product-render-image-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRender\\ImageInterface"},"catalog-data-product-render-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductRenderInterface","properties":{"wishlist_button":{"$ref":"#/definitions/catalog-data-product-render-button-interface"},"review_html":{"type":"string"}}},"catalog-inventory-data-stock-item-collection-interface":{"type":"object","description":"Interface StockItemCollectionInterface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"search_criteria":{"$ref":"#/definitions/catalog-inventory-stock-item-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-inventory-stock-item-criteria-interface":{"type":"object","description":"Interface StockItemCriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"product_id":{"type":"integer"},"stock_id":{"type":"integer"},"qty":{"type":"integer"},"stock_status":{"type":"integer"},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["product_id","stock_id","qty","stock_status","stock_item"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extension_attributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"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":"integer","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"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcard_item_option":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-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"},"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"},"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"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface","properties":{"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-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":{"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"}}},"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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrier_code":{"type":"string","description":"Shipping carrier code."},"method_code":{"type":"string","description":"Shipping method code."},"carrier_title":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"method_title":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"base_amount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"error_message":{"type":"string","description":"Shipping Error message."},"price_excl_tax":{"type":"number","description":"Shipping price excl tax."},"price_incl_tax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrier_code","method_code","amount","base_amount","available","error_message","price_excl_tax","price_incl_tax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grand_total":{"type":"number","description":"Grand total in quote currency"},"base_grand_total":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"base_subtotal":{"type":"number","description":"Subtotal in base currency"},"discount_amount":{"type":"number","description":"Discount amount in quote currency"},"base_discount_amount":{"type":"number","description":"Discount amount in base currency"},"subtotal_with_discount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"base_subtotal_with_discount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shipping_amount":{"type":"number","description":"Shipping amount in quote currency"},"base_shipping_amount":{"type":"number","description":"Shipping amount in base currency"},"shipping_discount_amount":{"type":"number","description":"Shipping discount amount in quote currency"},"base_shipping_discount_amount":{"type":"number","description":"Shipping discount amount in base currency"},"tax_amount":{"type":"number","description":"Tax amount in quote currency"},"base_tax_amount":{"type":"number","description":"Tax amount in base currency"},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount in quote currency"},"base_shipping_tax_amount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in quote currency"},"base_subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in base currency"},"shipping_incl_tax":{"type":"number","description":"Shipping including tax in quote currency"},"base_shipping_incl_tax":{"type":"number","description":"Shipping including tax in base currency"},"base_currency_code":{"type":"string","description":"Base currency code"},"quote_currency_code":{"type":"string","description":"Quote currency code"},"coupon_code":{"type":"string","description":"Applied coupon code"},"items_qty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"total_segments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weee_tax_applied_amount","total_segments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"item_id":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"base_price":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"row_total":{"type":"number","description":"Row total in quote currency."},"base_row_total":{"type":"number","description":"Row total in base currency."},"row_total_with_discount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"tax_amount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"base_tax_amount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"tax_percent":{"type":"number","description":"Tax percent. Otherwise, null."},"discount_amount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"base_discount_amount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discount_percent":{"type":"number","description":"Discount percent. Otherwise, null."},"price_incl_tax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"base_price_incl_tax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"row_total_incl_tax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"base_row_total_incl_tax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weee_tax_applied":{"type":"string","description":"Item weee tax applied in quote currency."},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["item_id","price","base_price","qty","row_total","base_row_total","options","weee_tax_applied_amount","weee_tax_applied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface","properties":{"negotiable_quote_item_totals":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-totals-interface"}}},"negotiable-quote-data-negotiable-quote-item-totals-interface":{"type":"object","description":"Extension attribute for quote item totals model.","properties":{"cost":{"type":"number","description":"Cost for quote item."},"catalog_price":{"type":"number","description":"Catalog price for quote item."},"base_catalog_price":{"type":"number","description":"Catalog price for quote item in base currency."},"catalog_price_incl_tax":{"type":"number","description":"Catalog price with included tax for quote item."},"base_catalog_price_incl_tax":{"type":"number","description":"Catalog price with included tax for quote item in base currency."},"cart_price":{"type":"number","description":"Cart price for quote item."},"base_cart_price":{"type":"number","description":"Cart price for quote item in base currency."},"cart_tax":{"type":"number","description":"Tax from catalog price for quote item."},"base_cart_tax":{"type":"number","description":"Tax from catalog price for quote item in base currency."},"cart_price_incl_tax":{"type":"number","description":"Cart price with included tax for quote item."},"base_cart_price_incl_tax":{"type":"number","description":"Cart price with included tax for quote item in base currency."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-item-totals-extension-interface"}},"required":["cost","catalog_price","base_catalog_price","catalog_price_incl_tax","base_catalog_price_incl_tax","cart_price","base_cart_price","cart_tax","base_cart_tax","cart_price_incl_tax","base_cart_price_incl_tax"]},"negotiable-quote-data-negotiable-quote-item-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\NegotiableQuoteItemTotalsInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extension_attributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"gift_cards":{"type":"string"},"tax_grandtotal_details":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}},"gw_order_id":{"type":"string"},"gw_item_ids":{"type":"array","items":{"type":"string"}},"gw_allow_gift_receipt":{"type":"string"},"gw_add_card":{"type":"string"},"gw_price":{"type":"string"},"gw_base_price":{"type":"string"},"gw_items_price":{"type":"string"},"gw_items_base_price":{"type":"string"},"gw_card_price":{"type":"string"},"gw_card_base_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_price_incl_tax":{"type":"string"},"gw_base_price_incl_tax":{"type":"string"},"gw_card_price_incl_tax":{"type":"string"},"gw_card_base_price_incl_tax":{"type":"string"},"gw_items_price_incl_tax":{"type":"string"},"gw_items_base_price_incl_tax":{"type":"string"}}},"tax-data-grand-total-details-interface":{"type":"object","description":"Interface GrandTotalDetailsInterface","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"group_id":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","group_id"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"Interface GrandTotalRatesInterface","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface","properties":{"coupon_label":{"type":"string"},"base_customer_balance_amount":{"type":"number"},"customer_balance_amount":{"type":"number"},"negotiable_quote_totals":{"$ref":"#/definitions/negotiable-quote-data-negotiable-quote-totals-interface"},"reward_points_balance":{"type":"number"},"reward_currency_amount":{"type":"number"},"base_reward_currency_amount":{"type":"number"}}},"negotiable-quote-data-negotiable-quote-totals-interface":{"type":"object","description":"Extension attribute for quote totals model.","properties":{"items_count":{"type":"integer","description":"The number of different items or products in the cart."},"quote_status":{"type":"string","description":"Negotiable quote status."},"created_at":{"type":"string","description":"The cart creation date and time."},"updated_at":{"type":"string","description":"The cart last update date and time."},"customer_group":{"type":"integer","description":"Customer group id."},"base_to_quote_rate":{"type":"number","description":"Base currency to quote currency rate."},"cost_total":{"type":"number","description":"Total cost for quote."},"base_cost_total":{"type":"number","description":"Total cost for quote in base currency."},"original_total":{"type":"number","description":"Original quote total."},"base_original_total":{"type":"number","description":"Original quote total in base currency."},"original_tax":{"type":"number","description":"Original tax amount for quote."},"base_original_tax":{"type":"number","description":"Original tax amount for quote in base currency."},"original_price_incl_tax":{"type":"number","description":"Original price with included tax for quote."},"base_original_price_incl_tax":{"type":"number","description":"Original price with included tax for quote in base currency."},"negotiated_price_type":{"type":"integer","description":"Negotiable quote type."},"negotiated_price_value":{"type":"number","description":"Negotiable price value for quote."}},"required":["items_count","quote_status","created_at","updated_at","customer_group","base_to_quote_rate","cost_total","base_cost_total","original_total","base_original_total","original_tax","base_original_tax","original_price_incl_tax","base_original_price_incl_tax","negotiated_price_type","negotiated_price_value"]},"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"},"framework-search-search-result-interface":{"type":"object","description":"Interface SearchResultInterface","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"search_criteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","aggregations","search_criteria","total_count"]},"framework-search-document-interface":{"type":"object","description":"Interface \\Magento\\Framework\\Api\\Search\\DocumentInterface","properties":{"id":{"type":"integer"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucket_names":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucket_names"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"Interface \\Magento\\Framework\\Api\\Search\\AggregationValueInterface","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"Interface SearchCriteriaInterface","properties":{"request_name":{"type":"string"},"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["request_name","filter_groups"]},"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"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"giftcard_item_option":{"$ref":"#/definitions/gift-card-data-gift-card-option-interface"},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-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"}}},"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"}},"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"},"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"},"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"}}},"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"},"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"]},"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"},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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"}}},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-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"},"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-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transaction_id":{"type":"integer","description":"Transaction ID."},"parent_id":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"order_id":{"type":"integer","description":"Order ID."},"payment_id":{"type":"integer","description":"Payment ID."},"txn_id":{"type":"string","description":"Transaction business ID."},"parent_txn_id":{"type":"string","description":"Parent transaction business ID."},"txn_type":{"type":"string","description":"Transaction type."},"is_closed":{"type":"integer","description":"Is-closed flag value."},"additional_information":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"created_at":{"type":"string","description":"Created-at timestamp."},"child_transactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transaction_id","order_id","payment_id","txn_id","parent_txn_id","txn_type","is_closed","created_at","child_transactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"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-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failed_items":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missing_items":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failed_items","missing_items"]},"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-payment-details-interface":{"type":"object","description":"Interface PaymentDetailsInterface","properties":{"payment_methods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extension_attributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["payment_methods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"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"},"checkout-agreements-data-agreement-interface":{"type":"object","description":"Interface AgreementInterface","properties":{"agreement_id":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"content_height":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkbox_text":{"type":"string","description":"Agreement checkbox text."},"is_active":{"type":"boolean","description":"Agreement status."},"is_html":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extension_attributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreement_id","name","content","checkbox_text","is_active","is_html","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"company-data-company-search-results-interface":{"type":"object","description":"Interface for company search results","properties":{"items":{"type":"array","description":"Companies list","items":{"$ref":"#/definitions/company-data-company-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-search-results-interface":{"type":"object","description":"Interface for company team search results","properties":{"items":{"type":"array","description":"Teams list","items":{"$ref":"#/definitions/company-data-team-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-hierarchy-interface":{"type":"object","description":"Company hierarchy DTO interface for WebAPI.","properties":{"structure_id":{"type":"integer","description":"Structure ID."},"entity_id":{"type":"integer","description":"Entity ID."},"entity_type":{"type":"string","description":"Entity type."},"structure_parent_id":{"type":"integer","description":"Structure parent ID."},"extension_attributes":{"$ref":"#/definitions/company-data-hierarchy-extension-interface"}}},"company-data-hierarchy-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Company\\Api\\Data\\HierarchyInterface"},"company-data-role-search-results-interface":{"type":"object","description":"Interface for role search results.","properties":{"items":{"type":"array","description":"Roles list.","items":{"$ref":"#/definitions/company-data-role-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"analytics-data-link-interface":{"type":"object","description":"Represents link with collected data and initialized vector for decryption.","properties":{"url":{"type":"string"},"initialization_vector":{"type":"string"}},"required":["url","initialization_vector"]},"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","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"},"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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"gift-wrapping-data-wrapping-search-results-interface":{"type":"object","description":"Interface WrappingSearchResultsInterface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/gift-wrapping-data-wrapping-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"inventory-api-data-source-search-results-interface":{"type":"object","description":"Search results of Repository::getList method Used fully qualified namespaces in annotations for proper work of WebApi request parser","properties":{"items":{"type":"array","description":"Sources list","items":{"$ref":"#/definitions/inventory-api-data-source-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-search-results-interface":{"type":"object","description":"Search results of Repository::getList method Used fully qualified namespaces in annotations for proper work of WebApi request parser","properties":{"items":{"type":"array","description":"Stocks list","items":{"$ref":"#/definitions/inventory-api-data-stock-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-search-results-interface":{"type":"object","description":"Search results of Repository::getList method Used fully qualified namespaces in annotations for proper work of WebApi request parser","properties":{"items":{"type":"array","description":"StockSourceLink list","items":{"$ref":"#/definitions/inventory-api-data-stock-source-link-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-search-results-interface":{"type":"object","description":"Search results of Repository::getList method Used fully qualified namespaces in annotations for proper work of WebApi request parser","properties":{"items":{"type":"array","description":"Source items list","items":{"$ref":"#/definitions/inventory-api-data-source-item-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-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-source-selection-algorithm-interface":{"type":"object","description":"Data Interface representing particular Source Selection Algorithm","properties":{"code":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"}},"required":["code","title","description"]},"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"}}},"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"}},"required":["sku","qty"]},"inventory-source-selection-api-data-source-selection-result-interface":{"type":"object","description":"Result of how we will deduct product qty from different Sources","properties":{"source_selection_items":{"type":"array","items":{"$ref":"#/definitions/inventory-source-selection-api-data-source-selection-item-interface"}},"shippable":{"type":"boolean"}},"required":["source_selection_items","shippable"]},"inventory-source-selection-api-data-source-selection-item-interface":{"type":"object","description":"Represents source selection result for the specific source and SKU","properties":{"source_code":{"type":"string","description":"Source code"},"sku":{"type":"string","description":"Item SKU"},"qty_to_deduct":{"type":"number","description":"Quantity which will be deducted for this source"},"qty_available":{"type":"number","description":"Available quantity for this source"}},"required":["source_code","sku","qty_to_deduct","qty_available"]},"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"},"negotiable-quote-data-comment-interface":{"type":"object","description":"Interface CommentInterface","properties":{"entity_id":{"type":"integer","description":"Comment ID."},"parent_id":{"type":"integer","description":"Negotiable quote ID, that this comment belongs to."},"creator_type":{"type":"integer","description":"The comment creator type."},"is_decline":{"type":"integer","description":"Is quote was declined by seller."},"is_draft":{"type":"integer","description":"Is quote draft flag."},"creator_id":{"type":"integer","description":"Comment creator ID."},"comment":{"type":"string","description":"Comment."},"created_at":{"type":"string","description":"Comment created at."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-comment-extension-interface"},"attachments":{"type":"array","description":"Existing attachments.","items":{"$ref":"#/definitions/negotiable-quote-data-comment-attachment-interface"}}},"required":["entity_id","parent_id","creator_type","is_decline","is_draft","creator_id","comment","created_at","attachments"]},"negotiable-quote-data-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentInterface"},"negotiable-quote-data-comment-attachment-interface":{"type":"object","description":"Interface for quote comment attachment.","properties":{"attachment_id":{"type":"integer","description":"Attachment ID."},"comment_id":{"type":"integer","description":"Comment ID."},"file_name":{"type":"string","description":"File name."},"file_path":{"type":"string","description":"File path."},"file_type":{"type":"string","description":"File type."},"extension_attributes":{"$ref":"#/definitions/negotiable-quote-data-comment-attachment-extension-interface"}},"required":["attachment_id","comment_id","file_name","file_path","file_type"]},"negotiable-quote-data-comment-attachment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\NegotiableQuote\\Api\\Data\\CommentAttachmentInterface"},"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 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"]},"shared-catalog-data-search-results-interface":{"type":"object","description":"Interface for Shared Catalog search results.","properties":{"items":{"type":"array","description":"Shared Catalog list.","items":{"$ref":"#/definitions/shared-catalog-data-shared-catalog-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-track-search-result-interface":{"type":"object","description":"Interface TrackSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-track-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"rma-data-comment-search-result-interface":{"type":"object","description":"Interface CommentSearchResultInterface","properties":{"items":{"type":"array","description":"Rma Status History list","items":{"$ref":"#/definitions/rma-data-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"rma-data-rma-search-result-interface":{"type":"object","description":"Interface RmaSearchResultInterface","properties":{"items":{"type":"array","description":"Rma list","items":{"$ref":"#/definitions/rma-data-rma-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"framework-metadata-object-interface":{"type":"object","description":"Provides metadata about an attribute.","properties":{"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["attribute_code"]},"company-credit-data-credit-limit-search-results-interface":{"type":"object","description":"Interface for Credit Limit search results.","properties":{"items":{"type":"array","description":"Credit Limit list.","items":{"$ref":"#/definitions/company-credit-data-credit-data-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-credit-data-interface":{"type":"object","description":"Credit Data 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."}},"required":["exceed_limit"]},"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"]},"company-credit-data-history-search-results-interface":{"type":"object","description":"Interface for History search results.","properties":{"items":{"type":"array","description":"History list.","items":{"$ref":"#/definitions/company-credit-data-history-data-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"company-credit-data-history-data-interface":{"type":"object","description":"History data transfer object interface.","properties":{"id":{"type":"integer","description":"ID."},"company_credit_id":{"type":"integer","description":"Company credit id."},"user_id":{"type":"integer","description":"User Id."},"user_type":{"type":"integer","description":"User type: integration, admin, customer."},"currency_credit":{"type":"string","description":"Currency code of credit."},"currency_operation":{"type":"string","description":"Currency code of operation."},"rate":{"type":"number","description":"Currency rate between credit and operation currencies."},"rate_credit":{"type":"number","description":"Rate between credit and base currencies."},"amount":{"type":"number","description":"Amount."},"balance":{"type":"number","description":"Outstanding balance."},"credit_limit":{"type":"number","description":"Credit limit."},"available_limit":{"type":"number","description":"Available limit."},"type":{"type":"integer","description":"Type of operation."},"datetime":{"type":"string","description":"Operation datetime."},"purchase_order":{"type":"string","description":"Purchase Order number."},"comment":{"type":"string","description":"Comment."}},"required":["rate","amount","balance","credit_limit"]},"asynchronous-operations-data-detailed-bulk-operations-status-interface":{"type":"object","description":"Interface BulkStatusInterface Bulk summary data with list of operations items full data.","properties":{"operations_list":{"type":"array","description":"Operations list.","items":{"$ref":"#/definitions/asynchronous-operations-data-operation-interface"}},"extension_attributes":{"$ref":"#/definitions/asynchronous-operations-data-bulk-summary-extension-interface"},"bulk_id":{"type":"string","description":"Bulk uuid"},"description":{"type":"string","description":"Bulk description"},"start_time":{"type":"string","description":"Bulk scheduled time"},"user_id":{"type":"integer","description":"User id"},"operation_count":{"type":"integer","description":"Total number of operations scheduled in scope of this bulk"}},"required":["operations_list","bulk_id","description","start_time","user_id","operation_count"]},"asynchronous-operations-data-operation-interface":{"type":"object","description":"Class OperationInterface","properties":{"extension_attributes":{"$ref":"#/definitions/asynchronous-operations-data-operation-extension-interface"},"id":{"type":"integer","description":"Id"},"bulk_uuid":{"type":"string","description":"Bulk uuid"},"topic_name":{"type":"string","description":"Queue Topic"},"serialized_data":{"type":"string","description":"Data"},"result_serialized_data":{"type":"string","description":"Serialized Data"},"status":{"type":"integer","description":"Operation status"},"result_message":{"type":"string","description":"Result message"},"error_code":{"type":"integer","description":"Error code"}},"required":["id","bulk_uuid","topic_name","serialized_data","result_serialized_data","status","result_message","error_code"]},"asynchronous-operations-data-operation-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\OperationInterface","properties":{"start_time":{"type":"string"}}},"asynchronous-operations-data-bulk-summary-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\AsynchronousOperations\\Api\\Data\\BulkSummaryInterface"},"asynchronous-operations-data-bulk-operations-status-interface":{"type":"object","description":"Interface BulkStatusInterface Bulk summary data with list of operations items summary data.","properties":{"operations_list":{"type":"array","description":"List of operation with statuses (short data).","items":{"$ref":"#/definitions/asynchronous-operations-data-summary-operation-status-interface"}},"extension_attributes":{"$ref":"#/definitions/asynchronous-operations-data-bulk-summary-extension-interface"},"bulk_id":{"type":"string","description":"Bulk uuid"},"description":{"type":"string","description":"Bulk description"},"start_time":{"type":"string","description":"Bulk scheduled time"},"user_id":{"type":"integer","description":"User id"},"operation_count":{"type":"integer","description":"Total number of operations scheduled in scope of this bulk"}},"required":["operations_list","bulk_id","description","start_time","user_id","operation_count"]},"asynchronous-operations-data-summary-operation-status-interface":{"type":"object","description":"Getter Class OperationsStatusInterface Instead of OperationInterface this class don't provide all operation data and not responsive to set any data, just to get operation data without serialized_data and result_serialized_data","properties":{"id":{"type":"integer","description":"Id"},"status":{"type":"integer","description":"Operation status"},"result_message":{"type":"string","description":"Result message"},"error_code":{"type":"integer","description":"Error code"}},"required":["id","status","result_message","error_code"]},"asynchronous-operations-data-operation-search-results-interface":{"type":"object","description":"Bulk operation search result interface. An bulk is a group of queue messages. An bulk operation item is a queue message.","properties":{"items":{"type":"array","description":"List of operations.","items":{"$ref":"#/definitions/asynchronous-operations-data-operation-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]}}} diff --git a/src/swagger/schemas/latest_develop.json b/src/swagger/schemas/latest_develop.json deleted file mode 100644 index f6c52d459ae..00000000000 --- a/src/swagger/schemas/latest_develop.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.2","title":"Magento Community"},"host":"10.234.129.215","basePath":"/builds/MD-PSSA-CCSA/instance-0/rest/default","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":"Interface ProductWebsiteLinkRepositoryInterface"},{"name":"searchV1","description":"Search API for all requests"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteGuestShipmentEstimationV1","description":"Interface GuestShipmentEstimationInterface"},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{id}":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","parameters":[{"name":"$body","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"put":{"tags":["quoteCartRepositoryV1"],"description":"Save quote","operationId":"quoteCartRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/items":{"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/create":{"put":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/":{"post":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"$body","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/refund":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Prepare creditmemo to refund and save it.","operationId":"salesCreditmemoManagementV1RefundPost","parameters":[{"name":"$body","in":"body","schema":{"required":["creditmemo"],"properties":{"creditmemo":{"$ref":"#/definitions/sales-data-creditmemo-interface"},"offlineRequested":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Configurable product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"$body","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"$body","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"$body","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"website_id":{"type":"integer"},"store_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","website_id","store_group_id"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"website_id":{"type":"integer"},"root_category_id":{"type":"integer"},"default_store_id":{"type":"integer"},"name":{"type":"string"},"extension_attributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","website_id","root_category_id","default_store_id","name"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"default_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","default_group_id"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"website_id":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"base_currency_code":{"type":"string","description":"Base currency code"},"default_display_currency_code":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weight_unit":{"type":"string","description":"The unit of weight"},"base_url":{"type":"string","description":"Base URL for the store"},"base_link_url":{"type":"string","description":"Base link URL for the store"},"base_static_url":{"type":"string","description":"Base static URL for the store"},"base_media_url":{"type":"string","description":"Base media URL for the store"},"secure_base_url":{"type":"string","description":"Secure base URL for the store"},"secure_base_link_url":{"type":"string","description":"Secure base link URL for the store"},"secure_base_static_url":{"type":"string","description":"Secure base static URL for the store"},"secure_base_media_url":{"type":"string","description":"Secure base media URL for the store"},"extension_attributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","website_id","locale","base_currency_code","default_display_currency_code","timezone","weight_unit","base_url","base_link_url","base_static_url","base_media_url","secure_base_url","secure_base_link_url","secure_base_static_url","secure_base_media_url"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"base_currency_code":{"type":"string","description":"The base currency code for the store."},"base_currency_symbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"default_display_currency_code":{"type":"string","description":"The default display currency code for the store."},"default_display_currency_symbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"available_currency_codes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchange_rates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["base_currency_code","base_currency_symbol","default_display_currency_code","default_display_currency_symbol","available_currency_codes","exchange_rates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currency_to":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extension_attributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currency_to","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"two_letter_abbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"three_letter_abbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"full_name_locale":{"type":"string","description":"The country full name (in store locale) for the store."},"full_name_english":{"type":"string","description":"The country full name (in English) for the store."},"available_regions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","two_letter_abbreviation","three_letter_abbreviation","full_name_locale","full_name_english"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extension_attributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"Interface AttributeSetSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["filter_groups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"condition_type":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"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-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontend_input":{"type":"string","description":"HTML for input element."},"input_filter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"store_label":{"type":"string","description":"Label of the store."},"validation_rules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multiline_count":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"data_model":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontend_class":{"type":"string","description":"Class which is used to display the attribute on frontend."},"user_defined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sort_order":{"type":"integer","description":"Attributes sort order."},"frontend_label":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backend_type":{"type":"string","description":"Backend type."},"is_used_in_grid":{"type":"boolean","description":"It is used in customer grid"},"is_visible_in_grid":{"type":"boolean","description":"It is visible in customer grid"},"is_filterable_in_grid":{"type":"boolean","description":"It is filterable in customer grid"},"is_searchable_in_grid":{"type":"boolean","description":"It is searchable in customer grid"},"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["frontend_input","input_filter","store_label","validation_rules","multiline_count","visible","required","data_model","options","frontend_class","user_defined","sort_order","frontend_label","note","system","backend_type","attribute_code"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"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":{"is_subscribed":{"type":"boolean"}}},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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":{"bundle_product_options":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}},"downloadable_product_links":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}},"downloadable_product_samples":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"configurable_product_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"configurable_product_links":{"type":"array","items":{"type":"integer"}}}},"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"},"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"},"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"},"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"},"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"},"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"},"catalog-data-product-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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","is_required","frontend_labels"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"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"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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","is_required","frontend_labels"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"Interface AttributeGroupSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-category-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"path":{"type":"string"},"available_sort_by":{"type":"array","items":{"type":"string"}},"include_in_menu":{"type":"boolean"},"extension_attributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"product_count":{"type":"integer","description":"Product count"},"children_data":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parent_id","name","is_active","position","level","product_count","children_data"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"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"]},"framework-search-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"search_criteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","aggregations","search_criteria","total_count"]},"framework-search-document-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucket_names":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucket_names"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"","properties":{"request_name":{"type":"string"},"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["request_name","filter_groups"]},"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":"integer","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"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-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"},"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"]},"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"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface"},"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"},"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"}}}},"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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrier_code":{"type":"string","description":"Shipping carrier code."},"method_code":{"type":"string","description":"Shipping method code."},"carrier_title":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"method_title":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"base_amount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"error_message":{"type":"string","description":"Shipping Error message."},"price_excl_tax":{"type":"number","description":"Shipping price excl tax."},"price_incl_tax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrier_code","method_code","amount","base_amount","available","error_message","price_excl_tax","price_incl_tax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grand_total":{"type":"number","description":"Grand total in quote currency"},"base_grand_total":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"base_subtotal":{"type":"number","description":"Subtotal in base currency"},"discount_amount":{"type":"number","description":"Discount amount in quote currency"},"base_discount_amount":{"type":"number","description":"Discount amount in base currency"},"subtotal_with_discount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"base_subtotal_with_discount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shipping_amount":{"type":"number","description":"Shipping amount in quote currency"},"base_shipping_amount":{"type":"number","description":"Shipping amount in base currency"},"shipping_discount_amount":{"type":"number","description":"Shipping discount amount in quote currency"},"base_shipping_discount_amount":{"type":"number","description":"Shipping discount amount in base currency"},"tax_amount":{"type":"number","description":"Tax amount in quote currency"},"base_tax_amount":{"type":"number","description":"Tax amount in base currency"},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount in quote currency"},"base_shipping_tax_amount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in quote currency"},"base_subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in base currency"},"shipping_incl_tax":{"type":"number","description":"Shipping including tax in quote currency"},"base_shipping_incl_tax":{"type":"number","description":"Shipping including tax in base currency"},"base_currency_code":{"type":"string","description":"Base currency code"},"quote_currency_code":{"type":"string","description":"Quote currency code"},"coupon_code":{"type":"string","description":"Applied coupon code"},"items_qty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"total_segments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weee_tax_applied_amount","total_segments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"item_id":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"base_price":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"row_total":{"type":"number","description":"Row total in quote currency."},"base_row_total":{"type":"number","description":"Row total in base currency."},"row_total_with_discount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"tax_amount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"base_tax_amount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"tax_percent":{"type":"number","description":"Tax percent. Otherwise, null."},"discount_amount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"base_discount_amount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discount_percent":{"type":"number","description":"Discount percent. Otherwise, null."},"price_incl_tax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"base_price_incl_tax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"row_total_incl_tax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"base_row_total_incl_tax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weee_tax_applied":{"type":"string","description":"Item weee tax applied in quote currency."},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["item_id","price","base_price","qty","row_total","base_row_total","options","weee_tax_applied_amount","weee_tax_applied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extension_attributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"tax_grandtotal_details":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}}}},"tax-data-grand-total-details-interface":{"type":"object","description":"Interface GrandTotalDetailsInterface","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"group_id":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","group_id"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"Interface GrandTotalRatesInterface","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface"},"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"}}},"checkout-agreements-data-agreement-interface":{"type":"object","description":"Interface AgreementInterface","properties":{"agreement_id":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"content_height":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkbox_text":{"type":"string","description":"Agreement checkbox text."},"is_active":{"type":"boolean","description":"Agreement status."},"is_html":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extension_attributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreement_id","name","content","checkbox_text","is_active","is_html","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extension_attributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"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"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-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"}}},"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"}},"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"},"gift_message":{"$ref":"#/definitions/gift-message-data-message-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"},"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"},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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."},"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."},"extension_attributes":{"$ref":"#/definitions/sales-data-invoice-item-extension-interface"}},"required":["order_item_id","qty","sku"]},"sales-data-invoice-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceItemInterface"},"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":{"comment":{"type":"string","description":"Comment."},"created_at":{"type":"string","description":"Created-at timestamp."},"entity_id":{"type":"integer","description":"Invoice 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-invoice-comment-extension-interface"}},"required":["comment","is_customer_notified","is_visible_on_front","parent_id"]},"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"},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-creditmemo-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-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"},"sales-data-creditmemo-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoInterface"},"sales-data-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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."},"order_item_id":{"type":"integer","description":"Order item ID."},"parent_id":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"product_id":{"type":"integer","description":"Product ID."},"qty":{"type":"number","description":"Quantity."},"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"}},"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":{"carrier_code":{"type":"string","description":"Carrier code."},"created_at":{"type":"string","description":"Created-at timestamp."},"description":{"type":"string","description":"Description."},"entity_id":{"type":"integer","description":"Shipment package ID."},"order_id":{"type":"integer","description":"The order_id for the shipment package."},"parent_id":{"type":"integer","description":"Parent ID."},"qty":{"type":"number","description":"Quantity."},"title":{"type":"string","description":"Title."},"track_number":{"type":"string","description":"Track number."},"updated_at":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-track-extension-interface"}},"required":["carrier_code","description","order_id","parent_id","qty","title","track_number","weight"]},"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":{"comment":{"type":"string","description":"Comment."},"created_at":{"type":"string","description":"Created-at timestamp."},"entity_id":{"type":"integer","description":"Shipment comment 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-shipment-comment-extension-interface"}},"required":["comment","is_customer_notified","is_visible_on_front","parent_id"]},"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"},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transaction_id":{"type":"integer","description":"Transaction ID."},"parent_id":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"order_id":{"type":"integer","description":"Order ID."},"payment_id":{"type":"integer","description":"Payment ID."},"txn_id":{"type":"string","description":"Transaction business ID."},"parent_txn_id":{"type":"string","description":"Parent transaction business ID."},"txn_type":{"type":"string","description":"Transaction type."},"is_closed":{"type":"integer","description":"Is-closed flag value."},"additional_information":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"created_at":{"type":"string","description":"Created-at timestamp."},"child_transactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transaction_id","order_id","payment_id","txn_id","parent_txn_id","txn_type","is_closed","created_at","child_transactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-inventory-data-stock-status-collection-interface":{"type":"object","description":"Stock Status collection interface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"search_criteria":{"$ref":"#/definitions/catalog-inventory-stock-status-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"product_id":{"type":"integer"},"stock_id":{"type":"integer"},"qty":{"type":"integer"},"stock_status":{"type":"integer"},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["product_id","stock_id","qty","stock_status","stock_item"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"catalog-inventory-stock-status-criteria-interface":{"type":"object","description":"Interface StockStatusCriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"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-payment-details-interface":{"type":"object","description":"Interface PaymentDetailsInterface","properties":{"payment_methods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extension_attributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["payment_methods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"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"},"sales-rule-data-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failed_items":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missing_items":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failed_items","missing_items"]},"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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]}}} \ No newline at end of file diff --git a/src/swagger/schemas/original-2.0.schema.json b/src/swagger/schemas/original-2.0.schema.json deleted file mode 100644 index cfd9129f525..00000000000 --- a/src/swagger/schemas/original-2.0.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"swagger":"2.0","info":{"version":"2.0","title":"Magento Community Edition"},"host":"m2.php5.dev","basePath":"/rest/default","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":""},{"name":"searchV1","description":"Search API for all requests"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customer.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{id}":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customer.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","parameters":[{"name":"$body","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save custom option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save custom option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-estimate-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteGuestShippingMethodManagementV1EstimateByAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-estimate-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Adds the specified item to the specified cart.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"$body","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve coupon.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"$body","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"$body","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"$body","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"websiteId":{"type":"integer"},"storeGroupId":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","websiteId","storeGroupId"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"websiteId":{"type":"integer"},"rootCategoryId":{"type":"integer"},"defaultStoreId":{"type":"integer"},"name":{"type":"string"},"extensionAttributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","websiteId","rootCategoryId","defaultStoreId","name"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"defaultGroupId":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","defaultGroupId"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"websiteId":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"defaultDisplayCurrencyCode":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weightUnit":{"type":"string","description":"The unit of weight"},"baseUrl":{"type":"string","description":"Base URL for the store"},"baseLinkUrl":{"type":"string","description":"Base link URL for the store"},"baseStaticUrl":{"type":"string","description":"Base static URL for the store"},"baseMediaUrl":{"type":"string","description":"Base media URL for the store"},"secureBaseUrl":{"type":"string","description":"Secure base URL for the store"},"secureBaseLinkUrl":{"type":"string","description":"Secure base link URL for the store"},"secureBaseStaticUrl":{"type":"string","description":"Secure base static URL for the store"},"secureBaseMediaUrl":{"type":"string","description":"Secure base media URL for the store"},"extensionAttributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","websiteId","locale","baseCurrencyCode","defaultDisplayCurrencyCode","timezone","weightUnit","baseUrl","baseLinkUrl","baseStaticUrl","baseMediaUrl","secureBaseUrl","secureBaseLinkUrl","secureBaseStaticUrl","secureBaseMediaUrl"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"baseCurrencyCode":{"type":"string","description":"The base currency code for the store."},"baseCurrencySymbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"defaultDisplayCurrencyCode":{"type":"string","description":"The default display currency code for the store."},"defaultDisplayCurrencySymbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"availableCurrencyCodes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchangeRates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extensionAttributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["baseCurrencyCode","baseCurrencySymbol","defaultDisplayCurrencyCode","defaultDisplayCurrencySymbol","availableCurrencyCodes","exchangeRates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currencyTo":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extensionAttributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currencyTo","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"twoLetterAbbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"threeLetterAbbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"fullNameLocale":{"type":"string","description":"The country full name (in store locale) for the store."},"fullNameEnglish":{"type":"string","description":"The country full name (in English) for the store."},"availableRegions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extensionAttributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","twoLetterAbbreviation","threeLetterAbbreviation","fullNameLocale","fullNameEnglish"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extensionAttributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"eav-data-attribute-set-interface":{"type":"object","description":"","properties":{"attributeSetId":{"type":"integer","description":"Attribute set ID"},"attributeSetName":{"type":"string","description":"Attribute set name"},"sortOrder":{"type":"integer","description":"Attribute set sort order index"},"entityTypeId":{"type":"integer","description":"Attribute set entity type id"},"extensionAttributes":{"$ref":"#/definitions/eav-data-attribute-set-extension-interface"}},"required":["attributeSetName","sortOrder"]},"eav-data-attribute-set-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Eav\\Api\\Data\\AttributeSetInterface"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filterGroups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sortOrders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"pageSize":{"type":"integer","description":"Page size."},"currentPage":{"type":"integer","description":"Current page."}},"required":["filterGroups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"conditionType":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"customer-data-group-interface":{"type":"object","description":"Customer group interface.","properties":{"id":{"type":"integer","description":"Id"},"code":{"type":"string","description":"Code"},"taxClassId":{"type":"integer","description":"Tax class id"},"taxClassName":{"type":"string","description":"Tax class name"},"extensionAttributes":{"$ref":"#/definitions/customer-data-group-extension-interface"}},"required":["code","taxClassId"]},"customer-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\GroupInterface"},"customer-data-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontendInput":{"type":"string","description":"HTML for input element."},"inputFilter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"storeLabel":{"type":"string","description":"Label of the store."},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multilineCount":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"dataModel":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontendClass":{"type":"string","description":"Class which is used to display the attribute on frontend."},"userDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sortOrder":{"type":"integer","description":"Attributes sort order."},"frontendLabel":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backendType":{"type":"string","description":"Backend type."},"isUsedInGrid":{"type":"boolean","description":"It is used in customer grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in customer grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in customer grid"},"isSearchableInGrid":{"type":"boolean","description":"It is searchable in customer grid"},"attributeCode":{"type":"string","description":"Code of the attribute."}},"required":["frontendInput","inputFilter","storeLabel","validationRules","multilineCount","visible","required","dataModel","options","frontendClass","userDefined","sortOrder","frontendLabel","note","system","backendType","attributeCode"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"customer-data-customer-interface":{"type":"object","description":"Customer interface.","properties":{"id":{"type":"integer","description":"Customer id"},"groupId":{"type":"integer","description":"Group id"},"defaultBilling":{"type":"string","description":"Default billing address id"},"defaultShipping":{"type":"string","description":"Default shipping address id"},"confirmation":{"type":"string","description":"Confirmation"},"createdAt":{"type":"string","description":"Created at time"},"updatedAt":{"type":"string","description":"Updated at time"},"createdIn":{"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"},"storeId":{"type":"integer","description":"Store id"},"taxvat":{"type":"string","description":"Tax Vat"},"websiteId":{"type":"integer","description":"Website id"},"addresses":{"type":"array","description":"Customer addresses.","items":{"$ref":"#/definitions/customer-data-address-interface"}},"disableAutoGroupChange":{"type":"integer","description":"Disable auto group change flag."},"extensionAttributes":{"$ref":"#/definitions/customer-data-customer-extension-interface"},"customAttributes":{"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"},"customerId":{"type":"integer","description":"Customer ID"},"region":{"$ref":"#/definitions/customer-data-region-interface"},"regionId":{"type":"integer","description":"Region ID"},"countryId":{"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"},"vatId":{"type":"string","description":"Vat id"},"defaultShipping":{"type":"boolean","description":"If this address is default shipping address."},"defaultBilling":{"type":"boolean","description":"If this address is default billing address"},"extensionAttributes":{"$ref":"#/definitions/customer-data-address-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}}},"customer-data-region-interface":{"type":"object","description":"Customer address region interface.","properties":{"regionCode":{"type":"string","description":"Region code"},"region":{"type":"string","description":"Region"},"regionId":{"type":"integer","description":"Region id"},"extensionAttributes":{"$ref":"#/definitions/customer-data-region-extension-interface"}},"required":["regionCode","region","regionId"]},"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":{"attributeCode":{"type":"string","description":"Attribute code"},"value":{"type":"string","description":"Attribute value"}},"required":["attributeCode","value"]},"customer-data-customer-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Customer\\Api\\Data\\CustomerInterface"},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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"},"pageLayout":{"type":"string","description":"Page layout"},"metaKeywords":{"type":"string","description":"Meta keywords"},"metaDescription":{"type":"string","description":"Meta description"},"contentHeading":{"type":"string","description":"Content heading"},"content":{"type":"string","description":"Content"},"creationTime":{"type":"string","description":"Creation time"},"updateTime":{"type":"string","description":"Update time"},"sortOrder":{"type":"string","description":"Sort order"},"layoutUpdateXml":{"type":"string","description":"Layout update xml"},"customTheme":{"type":"string","description":"Custom theme"},"customRootTemplate":{"type":"string","description":"Custom root template"},"customLayoutUpdateXml":{"type":"string","description":"Custom layout update xml"},"customThemeFrom":{"type":"string","description":"Custom theme from"},"customThemeTo":{"type":"string","description":"Custom theme to"},"active":{"type":"boolean","description":"Active"}},"required":["identifier"]},"cms-data-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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"},"creationTime":{"type":"string","description":"Creation time"},"updateTime":{"type":"string","description":"Update time"},"active":{"type":"boolean","description":"Active"}},"required":["identifier"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Id"},"sku":{"type":"string","description":"Sku"},"name":{"type":"string","description":"Name"},"attributeSetId":{"type":"integer","description":"Attribute set id"},"price":{"type":"number","description":"Price"},"status":{"type":"integer","description":"Status"},"visibility":{"type":"integer","description":"Visibility"},"typeId":{"type":"string","description":"Type id"},"createdAt":{"type":"string","description":"Created date"},"updatedAt":{"type":"string","description":"Updated date"},"weight":{"type":"number","description":"Weight"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-extension-interface"},"productLinks":{"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"}},"mediaGalleryEntries":{"type":"array","description":"Media gallery entries","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"tierPrices":{"type":"array","description":"List of product tier prices","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}},"customAttributes":{"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":{"bundleProductOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}},"downloadableProductLinks":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}},"downloadableProductSamples":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}},"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"configurableProductOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"configurableProductLinks":{"type":"array","items":{"type":"integer"}}}},"bundle-data-option-interface":{"type":"object","description":"Interface OptionInterface","properties":{"optionId":{"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"},"productLinks":{"type":"array","description":"Product links","items":{"$ref":"#/definitions/bundle-data-link-interface"}},"extensionAttributes":{"$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"},"optionId":{"type":"integer","description":"Option id"},"qty":{"type":"number","description":"Qty"},"position":{"type":"integer","description":"Position"},"isDefault":{"type":"boolean","description":"Is default"},"price":{"type":"number","description":"Price"},"priceType":{"type":"integer","description":"Price type"},"canChangeQuantity":{"type":"integer","description":"Whether quantity could be changed"},"extensionAttributes":{"$ref":"#/definitions/bundle-data-link-extension-interface"}},"required":["isDefault","price","priceType"]},"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"},"downloadable-data-link-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Sample(or link) id"},"title":{"type":"string"},"sortOrder":{"type":"integer"},"isShareable":{"type":"integer","description":"Shareable status"},"price":{"type":"number","description":"Price"},"numberOfDownloads":{"type":"integer","description":"Of downloads per user"},"linkType":{"type":"string"},"linkFile":{"type":"string","description":"relative file path"},"linkFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"linkUrl":{"type":"string","description":"Link url or null when type is 'file'"},"sampleType":{"type":"string"},"sampleFile":{"type":"string","description":"relative file path"},"sampleFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"sampleUrl":{"type":"string","description":"file URL"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-link-extension-interface"}},"required":["sortOrder","isShareable","price","linkType","sampleType"]},"downloadable-data-file-content-interface":{"type":"object","description":"","properties":{"fileData":{"type":"string","description":"Data (base64 encoded content)"},"name":{"type":"string","description":"File name"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-file-content-extension-interface"}},"required":["fileData","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"},"sortOrder":{"type":"integer","description":"Order index for sample"},"sampleType":{"type":"string"},"sampleFile":{"type":"string","description":"relative file path"},"sampleFileContent":{"$ref":"#/definitions/downloadable-data-file-content-interface"},"sampleUrl":{"type":"string","description":"file URL"},"extensionAttributes":{"$ref":"#/definitions/downloadable-data-sample-extension-interface"}},"required":["title","sortOrder","sampleType"]},"downloadable-data-sample-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Downloadable\\Api\\Data\\SampleInterface"},"catalog-inventory-data-stock-item-interface":{"type":"object","description":"Interface StockItem","properties":{"itemId":{"type":"integer"},"productId":{"type":"integer"},"stockId":{"type":"integer","description":"Stock identifier"},"qty":{"type":"number"},"isInStock":{"type":"boolean","description":"Stock Availability"},"isQtyDecimal":{"type":"boolean"},"showDefaultNotificationMessage":{"type":"boolean"},"useConfigMinQty":{"type":"boolean"},"minQty":{"type":"number","description":"Minimal quantity available for item status in stock"},"useConfigMinSaleQty":{"type":"integer"},"minSaleQty":{"type":"number","description":"Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation"},"useConfigMaxSaleQty":{"type":"boolean"},"maxSaleQty":{"type":"number","description":"Maximum Qty Allowed in Shopping Cart data wrapper"},"useConfigBackorders":{"type":"boolean"},"backorders":{"type":"integer","description":"Backorders status"},"useConfigNotifyStockQty":{"type":"boolean"},"notifyStockQty":{"type":"number","description":"Notify for Quantity Below data wrapper"},"useConfigQtyIncrements":{"type":"boolean"},"qtyIncrements":{"type":"number","description":"Quantity Increments data wrapper"},"useConfigEnableQtyInc":{"type":"boolean"},"enableQtyIncrements":{"type":"boolean","description":"Whether Quantity Increments is enabled"},"useConfigManageStock":{"type":"boolean"},"manageStock":{"type":"boolean","description":"Can Manage Stock"},"lowStockDate":{"type":"string"},"isDecimalDivided":{"type":"boolean"},"stockStatusChangedAuto":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/catalog-inventory-data-stock-item-extension-interface"}},"required":["qty","isInStock","isQtyDecimal","showDefaultNotificationMessage","useConfigMinQty","minQty","useConfigMinSaleQty","minSaleQty","useConfigMaxSaleQty","maxSaleQty","useConfigBackorders","backorders","useConfigNotifyStockQty","notifyStockQty","useConfigQtyIncrements","qtyIncrements","useConfigEnableQtyInc","enableQtyIncrements","useConfigManageStock","manageStock","lowStockDate","isDecimalDivided","stockStatusChangedAuto"]},"catalog-inventory-data-stock-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockItemInterface"},"configurable-product-data-option-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"attributeId":{"type":"string"},"label":{"type":"string"},"position":{"type":"integer"},"isUseDefault":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-value-interface"}},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-option-extension-interface"},"productId":{"type":"integer"}}},"configurable-product-data-option-value-interface":{"type":"object","description":"","properties":{"valueIndex":{"type":"integer"},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-option-value-extension-interface"}},"required":["valueIndex"]},"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"},"catalog-data-product-link-interface":{"type":"object","description":"","properties":{"sku":{"type":"string","description":"SKU"},"linkType":{"type":"string","description":"Link type"},"linkedProductSku":{"type":"string","description":"Linked product sku"},"linkedProductType":{"type":"string","description":"Linked product type (simple, virtual, etc)"},"position":{"type":"integer","description":"Linked item position"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-extension-interface"}},"required":["sku","linkType","linkedProductSku","linkedProductType","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":{"productSku":{"type":"string","description":"Product SKU"},"optionId":{"type":"integer","description":"Option id"},"title":{"type":"string","description":"Option title"},"type":{"type":"string","description":"Option type"},"sortOrder":{"type":"integer","description":"Sort order"},"isRequire":{"type":"boolean","description":"Is require"},"price":{"type":"number","description":"Price"},"priceType":{"type":"string","description":"Price type"},"sku":{"type":"string","description":"Sku"},"fileExtension":{"type":"string"},"maxCharacters":{"type":"integer"},"imageSizeX":{"type":"integer"},"imageSizeY":{"type":"integer"},"values":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-values-interface"}},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-custom-option-extension-interface"}},"required":["productSku","title","type","sortOrder","isRequire"]},"catalog-data-product-custom-option-values-interface":{"type":"object","description":"","properties":{"title":{"type":"string","description":"Option title"},"sortOrder":{"type":"integer","description":"Sort order"},"price":{"type":"number","description":"Price"},"priceType":{"type":"string","description":"Price type"},"sku":{"type":"string","description":"Sku"},"optionTypeId":{"type":"integer","description":"Option type id"}},"required":["title","sortOrder","price","priceType"]},"catalog-data-product-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionInterface"},"catalog-data-product-attribute-media-gallery-entry-interface":{"type":"object","description":"","properties":{"id":{"type":"integer","description":"Gallery entry ID"},"mediaType":{"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"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-extension-interface"}},"required":["mediaType","label","position","disabled","types"]},"framework-data-image-content-interface":{"type":"object","description":"Image Content data interface","properties":{"base64EncodedData":{"type":"string","description":"Media data (base64 encoded content)"},"type":{"type":"string","description":"MIME type"},"name":{"type":"string","description":"Image name"}},"required":["base64EncodedData","type","name"]},"catalog-data-product-attribute-media-gallery-entry-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeMediaGalleryEntryInterface","properties":{"videoContent":{"$ref":"#/definitions/framework-data-video-content-interface"}}},"framework-data-video-content-interface":{"type":"object","description":"Video Content data interface","properties":{"mediaType":{"type":"string","description":"MIME type"},"videoProvider":{"type":"string","description":"Provider"},"videoUrl":{"type":"string","description":"Video URL"},"videoTitle":{"type":"string","description":"Title"},"videoDescription":{"type":"string","description":"Video Description"},"videoMetadata":{"type":"string","description":"Metadata"}},"required":["mediaType","videoProvider","videoUrl","videoTitle","videoDescription","videoMetadata"]},"catalog-data-product-tier-price-interface":{"type":"object","description":"","properties":{"customerGroupId":{"type":"integer","description":"Customer group id"},"qty":{"type":"number","description":"Tier qty"},"value":{"type":"number","description":"Price value"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-tier-price-extension-interface"}},"required":["customerGroupId","qty","value"]},"catalog-data-product-tier-price-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTierPriceInterface"},"catalog-data-product-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"isWysiwygEnabled":{"type":"boolean","description":"WYSIWYG flag"},"isHtmlAllowedOnFront":{"type":"boolean","description":"The HTML tags are allowed on the frontend"},"usedForSortBy":{"type":"boolean","description":"It is used for sorting in product listing"},"isFilterable":{"type":"boolean","description":"It used in layered navigation"},"isFilterableInSearch":{"type":"boolean","description":"It is used in search results layered navigation"},"isUsedInGrid":{"type":"boolean","description":"It is used in catalog product grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in catalog product grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in catalog product grid"},"position":{"type":"integer","description":"Position"},"applyTo":{"type":"array","description":"Apply to value for the element","items":{"type":"string"}},"isSearchable":{"type":"string","description":"The attribute can be used in Quick Search"},"isVisibleInAdvancedSearch":{"type":"string","description":"The attribute can be used in Advanced Search"},"isComparable":{"type":"string","description":"The attribute can be compared on the frontend"},"isUsedForPromoRules":{"type":"string","description":"The attribute can be used for promo rules"},"isVisibleOnFront":{"type":"string","description":"The attribute is visible on the frontend"},"usedInProductListing":{"type":"string","description":"The attribute can be used in product listing"},"isVisible":{"type":"boolean","description":"Attribute is visible on frontend."},"scope":{"type":"string","description":"Attribute scope"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"attributeId":{"type":"integer","description":"Id of the attribute."},"attributeCode":{"type":"string","description":"Code of the attribute."},"frontendInput":{"type":"string","description":"HTML for input element."},"entityTypeId":{"type":"string","description":"Entity type id"},"isRequired":{"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"}},"isUserDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"defaultFrontendLabel":{"type":"string","description":"Frontend label for default store"},"frontendLabels":{"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."},"backendType":{"type":"string","description":"Backend type."},"backendModel":{"type":"string","description":"Backend model"},"sourceModel":{"type":"string","description":"Source model"},"defaultValue":{"type":"string","description":"Default value for the element."},"isUnique":{"type":"string","description":"This is a unique attribute"},"frontendClass":{"type":"string","description":"Frontend class of attribute"},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/eav-data-attribute-validation-rule-interface"}},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["attributeCode","frontendInput","isRequired","frontendLabels"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"eav-data-attribute-option-interface":{"type":"object","description":"Created from:","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"sortOrder":{"type":"integer","description":"Option order"},"isDefault":{"type":"boolean","description":"Default"},"storeLabels":{"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":"","properties":{"storeId":{"type":"integer","description":"Store id"},"label":{"type":"string","description":"Option label"}}},"eav-data-attribute-frontend-label-interface":{"type":"object","description":"","properties":{"storeId":{"type":"integer","description":"Store id"},"label":{"type":"string","description":"Option label"}}},"eav-data-attribute-validation-rule-interface":{"type":"object","description":"","properties":{"key":{"type":"string","description":"Object key"},"value":{"type":"string","description":"Object value"}},"required":["key","value"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"isWysiwygEnabled":{"type":"boolean","description":"WYSIWYG flag"},"isHtmlAllowedOnFront":{"type":"boolean","description":"The HTML tags are allowed on the frontend"},"usedForSortBy":{"type":"boolean","description":"It is used for sorting in product listing"},"isFilterable":{"type":"boolean","description":"It used in layered navigation"},"isFilterableInSearch":{"type":"boolean","description":"It is used in search results layered navigation"},"isUsedInGrid":{"type":"boolean","description":"It is used in catalog product grid"},"isVisibleInGrid":{"type":"boolean","description":"It is visible in catalog product grid"},"isFilterableInGrid":{"type":"boolean","description":"It is filterable in catalog product grid"},"position":{"type":"integer","description":"Position"},"applyTo":{"type":"array","description":"Apply to value for the element","items":{"type":"string"}},"isSearchable":{"type":"string","description":"The attribute can be used in Quick Search"},"isVisibleInAdvancedSearch":{"type":"string","description":"The attribute can be used in Advanced Search"},"isComparable":{"type":"string","description":"The attribute can be compared on the frontend"},"isUsedForPromoRules":{"type":"string","description":"The attribute can be used for promo rules"},"isVisibleOnFront":{"type":"string","description":"The attribute is visible on the frontend"},"usedInProductListing":{"type":"string","description":"The attribute can be used in product listing"},"isVisible":{"type":"boolean","description":"Attribute is visible on frontend."},"scope":{"type":"string","description":"Attribute scope"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"attributeId":{"type":"integer","description":"Id of the attribute."},"attributeCode":{"type":"string","description":"Code of the attribute."},"frontendInput":{"type":"string","description":"HTML for input element."},"entityTypeId":{"type":"string","description":"Entity type id"},"isRequired":{"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"}},"isUserDefined":{"type":"boolean","description":"Current attribute has been defined by a user."},"defaultFrontendLabel":{"type":"string","description":"Frontend label for default store"},"frontendLabels":{"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."},"backendType":{"type":"string","description":"Backend type."},"backendModel":{"type":"string","description":"Backend model"},"sourceModel":{"type":"string","description":"Source model"},"defaultValue":{"type":"string","description":"Default value for the element."},"isUnique":{"type":"string","description":"This is a unique attribute"},"frontendClass":{"type":"string","description":"Frontend class of attribute"},"validationRules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/eav-data-attribute-validation-rule-interface"}},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["attributeCode","frontendInput","isRequired","frontendLabels"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"eav-data-attribute-group-interface":{"type":"object","description":"","properties":{"attributeGroupId":{"type":"string","description":"Id"},"attributeGroupName":{"type":"string","description":"Name"},"attributeSetId":{"type":"integer","description":"Attribute set id"},"extensionAttributes":{"$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"},"catalog-data-category-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"parentId":{"type":"integer","description":"Parent category ID"},"name":{"type":"string","description":"Category name"},"isActive":{"type":"boolean","description":"Whether category is active"},"position":{"type":"integer","description":"Category position"},"level":{"type":"integer","description":"Category level"},"children":{"type":"string"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"path":{"type":"string"},"availableSortBy":{"type":"array","items":{"type":"string"}},"includeInMenu":{"type":"boolean"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"parentId":{"type":"integer","description":"Parent category ID"},"name":{"type":"string","description":"Category name"},"isActive":{"type":"boolean","description":"Whether category is active"},"position":{"type":"integer","description":"Category position"},"level":{"type":"integer","description":"Category level"},"productCount":{"type":"integer","description":"Product count"},"childrenData":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parentId","name","isActive","position","level","productCount","childrenData"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"catalog-data-category-product-link-interface":{"type":"object","description":"","properties":{"sku":{"type":"string"},"position":{"type":"integer"},"categoryId":{"type":"string","description":"Category id"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-category-product-link-extension-interface"}},"required":["categoryId"]},"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"},"websiteId":{"type":"integer","description":"Website ids"}},"required":["sku","websiteId"]},"framework-search-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"searchCriteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","aggregations","searchCriteria","totalCount"]},"framework-search-document-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucketNames":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucketNames"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"","properties":{"requestName":{"type":"string"},"filterGroups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sortOrders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"pageSize":{"type":"integer","description":"Page size."},"currentPage":{"type":"integer","description":"Current page."}},"required":["requestName","filterGroups"]},"quote-data-cart-interface":{"type":"object","description":"Interface CartInterface","properties":{"id":{"type":"integer","description":"Cart/quote ID."},"createdAt":{"type":"string","description":"Cart creation date and time. Otherwise, null."},"updatedAt":{"type":"string","description":"Cart last update date and time. Otherwise, null."},"convertedAt":{"type":"string","description":"Cart conversion date and time. Otherwise, null."},"isActive":{"type":"boolean","description":"Active status flag value. Otherwise, null."},"isVirtual":{"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"}},"itemsCount":{"type":"integer","description":"Number of different items or products in the cart. Otherwise, null."},"itemsQty":{"type":"number","description":"Total quantity of all cart items. Otherwise, null."},"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"reservedOrderId":{"type":"integer","description":"Reserved order ID. Otherwise, null."},"origOrderId":{"type":"integer","description":"Original order ID. Otherwise, null."},"currency":{"$ref":"#/definitions/quote-data-currency-interface"},"customerIsGuest":{"type":"boolean","description":"For guest customers, false for logged in customers"},"customerNote":{"type":"string","description":"Notice text"},"customerNoteNotify":{"type":"boolean","description":"Customer notification flag"},"customerTaxClassId":{"type":"integer","description":"Customer tax class ID."},"storeId":{"type":"integer","description":"Store identifier"},"extensionAttributes":{"$ref":"#/definitions/quote-data-cart-extension-interface"}},"required":["id","customer","storeId"]},"quote-data-cart-item-interface":{"type":"object","description":"Interface CartItemInterface","properties":{"itemId":{"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."},"productType":{"type":"string","description":"Product type. Otherwise, null."},"quoteId":{"type":"string","description":"Quote id."},"productOption":{"$ref":"#/definitions/quote-data-product-option-interface"},"extensionAttributes":{"$ref":"#/definitions/quote-data-cart-item-extension-interface"}},"required":["qty","quoteId"]},"quote-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extensionAttributes":{"$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":{"customOptions":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"bundleOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}},"downloadableOption":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"configurableItemOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}}}},"catalog-data-custom-option-interface":{"type":"object","description":"Interface CustomOptionInterface","properties":{"optionId":{"type":"string","description":"Option id"},"optionValue":{"type":"string","description":"Option value"},"extensionAttributes":{"$ref":"#/definitions/catalog-data-custom-option-extension-interface"}},"required":["optionId","optionValue"]},"catalog-data-custom-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CustomOptionInterface","properties":{"fileInfo":{"$ref":"#/definitions/framework-data-image-content-interface"}}},"bundle-data-bundle-option-interface":{"type":"object","description":"Interface BundleOptionInterface","properties":{"optionId":{"type":"integer","description":"Bundle option id."},"optionQty":{"type":"integer","description":"Bundle option quantity."},"optionSelections":{"type":"array","description":"Bundle option selection ids.","items":{"type":"integer"}},"extensionAttributes":{"$ref":"#/definitions/bundle-data-bundle-option-extension-interface"}},"required":["optionId","optionQty","optionSelections"]},"bundle-data-bundle-option-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\BundleOptionInterface"},"downloadable-data-downloadable-option-interface":{"type":"object","description":"Downloadable Option","properties":{"downloadableLinks":{"type":"array","description":"The list of downloadable links","items":{"type":"integer"}}},"required":["downloadableLinks"]},"configurable-product-data-configurable-item-option-value-interface":{"type":"object","description":"Interface ConfigurableItemOptionValueInterface","properties":{"optionId":{"type":"string","description":"Option SKU"},"optionValue":{"type":"integer","description":"Item id"},"extensionAttributes":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-extension-interface"}},"required":["optionId"]},"configurable-product-data-configurable-item-option-value-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\ConfigurableProduct\\Api\\Data\\ConfigurableItemOptionValueInterface"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface"},"quote-data-address-interface":{"type":"object","description":"Interface AddressInterface","properties":{"id":{"type":"integer","description":"Id"},"region":{"type":"string","description":"Region name"},"regionId":{"type":"integer","description":"Region id"},"regionCode":{"type":"string","description":"Region code"},"countryId":{"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"},"vatId":{"type":"string","description":"Vat id"},"customerId":{"type":"integer","description":"Customer id"},"email":{"type":"string","description":"Billing/shipping email"},"sameAsBilling":{"type":"integer","description":"Same as billing flag"},"customerAddressId":{"type":"integer","description":"Customer address id"},"saveInAddressBook":{"type":"integer","description":"Save in address book flag"},"extensionAttributes":{"$ref":"#/definitions/quote-data-address-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["region","regionId","regionCode","countryId","street","telephone","postcode","city","firstname","lastname","email"]},"quote-data-address-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\AddressInterface"},"quote-data-currency-interface":{"type":"object","description":"Interface CurrencyInterface","properties":{"globalCurrencyCode":{"type":"string","description":"Global currency code"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"storeCurrencyCode":{"type":"string","description":"Store currency code"},"quoteCurrencyCode":{"type":"string","description":"Quote currency code"},"storeToBaseRate":{"type":"number","description":"Store currency to base currency rate"},"storeToQuoteRate":{"type":"number","description":"Store currency to quote currency rate"},"baseToGlobalRate":{"type":"number","description":"Base currency to global currency rate"},"baseToQuoteRate":{"type":"number","description":"Base currency to quote currency rate"},"extensionAttributes":{"$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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"quote-data-payment-interface":{"type":"object","description":"Interface PaymentInterface","properties":{"poNumber":{"type":"string","description":"Purchase order number"},"method":{"type":"string","description":"Payment method code"},"additionalData":{"type":"array","description":"Payment additional details","items":{"type":"string"}},"extensionAttributes":{"$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":{"agreementIds":{"type":"array","items":{"type":"string"}}}},"quote-data-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrierCode":{"type":"string","description":"Shipping carrier code."},"methodCode":{"type":"string","description":"Shipping method code."},"carrierTitle":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"methodTitle":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"baseAmount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extensionAttributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"errorMessage":{"type":"string","description":"Shipping Error message."},"priceExclTax":{"type":"number","description":"Shipping price excl tax."},"priceInclTax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrierCode","methodCode","amount","baseAmount","available","errorMessage","priceExclTax","priceInclTax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-estimate-address-interface":{"type":"object","description":"Interface EstimateAddressInterface","properties":{"region":{"type":"string","description":"Region name"},"regionId":{"type":"integer","description":"Region id"},"countryId":{"type":"string","description":"Country id"},"postcode":{"type":"string","description":"Postcode"},"extensionAttributes":{"$ref":"#/definitions/quote-data-estimate-address-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["region","regionId","countryId","postcode"]},"quote-data-estimate-address-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\EstimateAddressInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grandTotal":{"type":"number","description":"Grand total in quote currency"},"baseGrandTotal":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"baseSubtotal":{"type":"number","description":"Subtotal in base currency"},"discountAmount":{"type":"number","description":"Discount amount in quote currency"},"baseDiscountAmount":{"type":"number","description":"Discount amount in base currency"},"subtotalWithDiscount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"baseSubtotalWithDiscount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shippingAmount":{"type":"number","description":"Shipping amount in quote currency"},"baseShippingAmount":{"type":"number","description":"Shipping amount in base currency"},"shippingDiscountAmount":{"type":"number","description":"Shipping discount amount in quote currency"},"baseShippingDiscountAmount":{"type":"number","description":"Shipping discount amount in base currency"},"taxAmount":{"type":"number","description":"Tax amount in quote currency"},"baseTaxAmount":{"type":"number","description":"Tax amount in base currency"},"weeeTaxAppliedAmount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount in quote currency"},"baseShippingTaxAmount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotalInclTax":{"type":"number","description":"Subtotal including tax in quote currency"},"baseSubtotalInclTax":{"type":"number","description":"Subtotal including tax in base currency"},"shippingInclTax":{"type":"number","description":"Shipping including tax in quote currency"},"baseShippingInclTax":{"type":"number","description":"Shipping including tax in base currency"},"baseCurrencyCode":{"type":"string","description":"Base currency code"},"quoteCurrencyCode":{"type":"string","description":"Quote currency code"},"couponCode":{"type":"string","description":"Applied coupon code"},"itemsQty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"totalSegments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weeeTaxAppliedAmount","totalSegments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"itemId":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"basePrice":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"rowTotal":{"type":"number","description":"Row total in quote currency."},"baseRowTotal":{"type":"number","description":"Row total in base currency."},"rowTotalWithDiscount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"taxAmount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"baseTaxAmount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"taxPercent":{"type":"number","description":"Tax percent. Otherwise, null."},"discountAmount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"baseDiscountAmount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discountPercent":{"type":"number","description":"Discount percent. Otherwise, null."},"priceInclTax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"basePriceInclTax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"rowTotalInclTax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"baseRowTotalInclTax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weeeTaxAppliedAmount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weeeTaxApplied":{"type":"string","description":"Item weee tax applied in quote currency."},"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["itemId","price","basePrice","qty","rowTotal","baseRowTotal","options","weeeTaxAppliedAmount","weeeTaxApplied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extensionAttributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"taxGrandtotalDetails":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}}}},"tax-data-grand-total-details-interface":{"type":"object","description":"","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"groupId":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","groupId"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface"},"quote-data-totals-additional-data-interface":{"type":"object","description":"Additional data for totals collection.","properties":{"extensionAttributes":{"$ref":"#/definitions/quote-data-totals-additional-data-extension-interface"},"customAttributes":{"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":{"giftMessages":{"type":"array","items":{"$ref":"#/definitions/gift-message-data-message-interface"}}}},"gift-message-data-message-interface":{"type":"object","description":"","properties":{"giftMessageId":{"type":"integer","description":"Gift message ID. Otherwise, null."},"customerId":{"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."},"extensionAttributes":{"$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":{"entityId":{"type":"string"},"entityType":{"type":"string"}}},"checkout-agreements-data-agreement-interface":{"type":"object","description":"","properties":{"agreementId":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"contentHeight":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkboxText":{"type":"string","description":"Agreement checkbox text."},"isActive":{"type":"boolean","description":"Agreement status."},"isHtml":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extensionAttributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreementId","name","content","checkboxText","isActive","isHtml","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extensionAttributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"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":{"adjustmentNegative":{"type":"number","description":"Negative adjustment value."},"adjustmentPositive":{"type":"number","description":"Positive adjustment value."},"appliedRuleIds":{"type":"string","description":"Applied rule IDs."},"baseAdjustmentNegative":{"type":"number","description":"Base negative adjustment value."},"baseAdjustmentPositive":{"type":"number","description":"Base positive adjustment value."},"baseCurrencyCode":{"type":"string","description":"Base currency code."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountCanceled":{"type":"number","description":"Base discount canceled."},"baseDiscountInvoiced":{"type":"number","description":"Base discount invoiced."},"baseDiscountRefunded":{"type":"number","description":"Base discount refunded."},"baseGrandTotal":{"type":"number","description":"Base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseDiscountTaxCompensationInvoiced":{"type":"number","description":"Base discount tax compensation invoiced."},"baseDiscountTaxCompensationRefunded":{"type":"number","description":"Base discount tax compensation refunded."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingCanceled":{"type":"number","description":"Base shipping canceled."},"baseShippingDiscountAmount":{"type":"number","description":"Base shipping discount amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Base shipping including tax."},"baseShippingInvoiced":{"type":"number","description":"Base shipping invoiced."},"baseShippingRefunded":{"type":"number","description":"Base shipping refunded."},"baseShippingTaxAmount":{"type":"number","description":"Base shipping tax amount."},"baseShippingTaxRefunded":{"type":"number","description":"Base shipping tax refunded."},"baseSubtotal":{"type":"number","description":"Base subtotal."},"baseSubtotalCanceled":{"type":"number","description":"Base subtotal canceled."},"baseSubtotalInclTax":{"type":"number","description":"Base subtotal including tax."},"baseSubtotalInvoiced":{"type":"number","description":"Base subtotal invoiced."},"baseSubtotalRefunded":{"type":"number","description":"Base subtotal refunded."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTaxCanceled":{"type":"number","description":"Base tax canceled."},"baseTaxInvoiced":{"type":"number","description":"Base tax invoiced."},"baseTaxRefunded":{"type":"number","description":"Base tax refunded."},"baseTotalCanceled":{"type":"number","description":"Base total canceled."},"baseTotalDue":{"type":"number","description":"Base total due."},"baseTotalInvoiced":{"type":"number","description":"Base total invoiced."},"baseTotalInvoicedCost":{"type":"number","description":"Base total invoiced cost."},"baseTotalOfflineRefunded":{"type":"number","description":"Base total offline refunded."},"baseTotalOnlineRefunded":{"type":"number","description":"Base total online refunded."},"baseTotalPaid":{"type":"number","description":"Base total paid."},"baseTotalQtyOrdered":{"type":"number","description":"Base total quantity ordered."},"baseTotalRefunded":{"type":"number","description":"Base total refunded."},"baseToGlobalRate":{"type":"number","description":"Base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Base-to-order rate."},"billingAddressId":{"type":"integer","description":"Billing address ID."},"canShipPartially":{"type":"integer","description":"Can-ship-partially flag value."},"canShipPartiallyItem":{"type":"integer","description":"Can-ship-partially-item flag value."},"couponCode":{"type":"string","description":"Coupon code."},"createdAt":{"type":"string","description":"Created-at timestamp."},"customerDob":{"type":"string","description":"Customer date-of-birth (DOB)."},"customerEmail":{"type":"string","description":"Customer email address."},"customerFirstname":{"type":"string","description":"Customer first name."},"customerGender":{"type":"integer","description":"Customer gender."},"customerGroupId":{"type":"integer","description":"Customer group ID."},"customerId":{"type":"integer","description":"Customer ID."},"customerIsGuest":{"type":"integer","description":"Customer-is-guest flag value."},"customerLastname":{"type":"string","description":"Customer last name."},"customerMiddlename":{"type":"string","description":"Customer middle name."},"customerNote":{"type":"string","description":"Customer note."},"customerNoteNotify":{"type":"integer","description":"Customer-note-notify flag value."},"customerPrefix":{"type":"string","description":"Customer prefix."},"customerSuffix":{"type":"string","description":"Customer suffix."},"customerTaxvat":{"type":"string","description":"Customer value-added tax (VAT)."},"discountAmount":{"type":"number","description":"Discount amount."},"discountCanceled":{"type":"number","description":"Discount canceled."},"discountDescription":{"type":"string","description":"Discount description."},"discountInvoiced":{"type":"number","description":"Discount invoiced."},"discountRefunded":{"type":"number","description":"Discount refunded amount."},"editIncrement":{"type":"integer","description":"Edit increment value."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Order ID."},"extCustomerId":{"type":"string","description":"External customer ID."},"extOrderId":{"type":"string","description":"External order ID."},"forcedShipmentWithInvoice":{"type":"integer","description":"Forced-shipment-with-invoice flag value."},"globalCurrencyCode":{"type":"string","description":"Global currency code."},"grandTotal":{"type":"number","description":"Grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"discountTaxCompensationInvoiced":{"type":"number","description":"Discount tax compensation invoiced amount."},"discountTaxCompensationRefunded":{"type":"number","description":"Discount tax compensation refunded amount."},"holdBeforeState":{"type":"string","description":"Hold before state."},"holdBeforeStatus":{"type":"string","description":"Hold before status."},"incrementId":{"type":"string","description":"Increment ID."},"isVirtual":{"type":"integer","description":"Is-virtual flag value."},"orderCurrencyCode":{"type":"string","description":"Order currency code."},"originalIncrementId":{"type":"string","description":"Original increment ID."},"paymentAuthorizationAmount":{"type":"number","description":"Payment authorization amount."},"paymentAuthExpiration":{"type":"integer","description":"Payment authorization expiration date."},"protectCode":{"type":"string","description":"Protect code."},"quoteAddressId":{"type":"integer","description":"Quote address ID."},"quoteId":{"type":"integer","description":"Quote ID."},"relationChildId":{"type":"string","description":"Relation child ID."},"relationChildRealId":{"type":"string","description":"Relation child real ID."},"relationParentId":{"type":"string","description":"Relation parent ID."},"relationParentRealId":{"type":"string","description":"Relation parent real ID."},"remoteIp":{"type":"string","description":"Remote IP address."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingCanceled":{"type":"number","description":"Shipping canceled amount."},"shippingDescription":{"type":"string","description":"Shipping description."},"shippingDiscountAmount":{"type":"number","description":"Shipping discount amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Shipping including tax amount."},"shippingInvoiced":{"type":"number","description":"Shipping invoiced amount."},"shippingRefunded":{"type":"number","description":"Shipping refunded amount."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount."},"shippingTaxRefunded":{"type":"number","description":"Shipping tax refunded amount."},"state":{"type":"string","description":"State."},"status":{"type":"string","description":"Status."},"storeCurrencyCode":{"type":"string","description":"Store currency code."},"storeId":{"type":"integer","description":"Store ID."},"storeName":{"type":"string","description":"Store name."},"storeToBaseRate":{"type":"number","description":"Store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Store-to-order rate."},"subtotal":{"type":"number","description":"Subtotal."},"subtotalCanceled":{"type":"number","description":"Subtotal canceled amount."},"subtotalInclTax":{"type":"number","description":"Subtotal including tax amount."},"subtotalInvoiced":{"type":"number","description":"Subtotal invoiced amount."},"subtotalRefunded":{"type":"number","description":"Subtotal refunded amount."},"taxAmount":{"type":"number","description":"Tax amount."},"taxCanceled":{"type":"number","description":"Tax canceled amount."},"taxInvoiced":{"type":"number","description":"Tax invoiced amount."},"taxRefunded":{"type":"number","description":"Tax refunded amount."},"totalCanceled":{"type":"number","description":"Total canceled."},"totalDue":{"type":"number","description":"Total due."},"totalInvoiced":{"type":"number","description":"Total invoiced amount."},"totalItemCount":{"type":"integer","description":"Total item count."},"totalOfflineRefunded":{"type":"number","description":"Total offline refunded amount."},"totalOnlineRefunded":{"type":"number","description":"Total online refunded amount."},"totalPaid":{"type":"number","description":"Total paid."},"totalQtyOrdered":{"type":"number","description":"Total quantity ordered."},"totalRefunded":{"type":"number","description":"Total amount refunded."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"xForwardedFor":{"type":"string","description":"X-Forwarded-For field value."},"items":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"billingAddress":{"$ref":"#/definitions/sales-data-order-address-interface"},"payment":{"$ref":"#/definitions/sales-data-order-payment-interface"},"statusHistories":{"type":"array","description":"Array of status histories.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-extension-interface"}},"required":["baseGrandTotal","baseDiscountTaxCompensationAmount","baseDiscountTaxCompensationInvoiced","baseDiscountTaxCompensationRefunded","baseShippingDiscountTaxCompensationAmnt","customerEmail","grandTotal","discountTaxCompensationAmount","discountTaxCompensationInvoiced","discountTaxCompensationRefunded","shippingDiscountTaxCompensationAmount","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":{"additionalData":{"type":"string","description":"Additional data."},"amountRefunded":{"type":"number","description":"Amount refunded."},"appliedRuleIds":{"type":"string","description":"Applied rule IDs."},"baseAmountRefunded":{"type":"number","description":"Base amount refunded."},"baseCost":{"type":"number","description":"Base cost."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountInvoiced":{"type":"number","description":"Base discount invoiced."},"baseDiscountRefunded":{"type":"number","description":"Base discount refunded."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseDiscountTaxCompensationInvoiced":{"type":"number","description":"Base discount tax compensation invoiced."},"baseDiscountTaxCompensationRefunded":{"type":"number","description":"Base discount tax compensation refunded."},"baseOriginalPrice":{"type":"number","description":"Base original price."},"basePrice":{"type":"number","description":"Base price."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowInvoiced":{"type":"number","description":"Base row invoiced."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTaxBeforeDiscount":{"type":"number","description":"Base tax before discount."},"baseTaxInvoiced":{"type":"number","description":"Base tax invoiced."},"baseTaxRefunded":{"type":"number","description":"Base tax refunded."},"baseWeeeTaxAppliedAmount":{"type":"number","description":"Base WEEE tax applied amount."},"baseWeeeTaxAppliedRowAmnt":{"type":"number","description":"Base WEEE tax applied row amount."},"baseWeeeTaxDisposition":{"type":"number","description":"Base WEEE tax disposition."},"baseWeeeTaxRowDisposition":{"type":"number","description":"Base WEEE tax row disposition."},"createdAt":{"type":"string","description":"Created-at timestamp."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"discountInvoiced":{"type":"number","description":"Discount invoiced."},"discountPercent":{"type":"number","description":"Discount percent."},"discountRefunded":{"type":"number","description":"Discount refunded."},"eventId":{"type":"integer","description":"Event ID."},"extOrderItemId":{"type":"string","description":"External order item ID."},"freeShipping":{"type":"integer","description":"Free-shipping flag value."},"gwBasePrice":{"type":"number","description":"GW base price."},"gwBasePriceInvoiced":{"type":"number","description":"GW base price invoiced."},"gwBasePriceRefunded":{"type":"number","description":"GW base price refunded."},"gwBaseTaxAmount":{"type":"number","description":"GW base tax amount."},"gwBaseTaxAmountInvoiced":{"type":"number","description":"GW base tax amount invoiced."},"gwBaseTaxAmountRefunded":{"type":"number","description":"GW base tax amount refunded."},"gwId":{"type":"integer","description":"GW ID."},"gwPrice":{"type":"number","description":"GW price."},"gwPriceInvoiced":{"type":"number","description":"GW price invoiced."},"gwPriceRefunded":{"type":"number","description":"GW price refunded."},"gwTaxAmount":{"type":"number","description":"GW tax amount."},"gwTaxAmountInvoiced":{"type":"number","description":"GW tax amount invoiced."},"gwTaxAmountRefunded":{"type":"number","description":"GW tax amount refunded."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"discountTaxCompensationCanceled":{"type":"number","description":"Discount tax compensation canceled."},"discountTaxCompensationInvoiced":{"type":"number","description":"Discount tax compensation invoiced."},"discountTaxCompensationRefunded":{"type":"number","description":"Discount tax compensation refunded."},"isQtyDecimal":{"type":"integer","description":"Is-quantity-decimal flag value."},"isVirtual":{"type":"integer","description":"Is-virtual flag value."},"itemId":{"type":"integer","description":"Item ID."},"lockedDoInvoice":{"type":"integer","description":"Locked DO invoice flag value."},"lockedDoShip":{"type":"integer","description":"Locked DO ship flag value."},"name":{"type":"string","description":"Name."},"noDiscount":{"type":"integer","description":"No-discount flag value."},"orderId":{"type":"integer","description":"Order ID."},"originalPrice":{"type":"number","description":"Original price."},"parentItemId":{"type":"integer","description":"Parent item ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"productType":{"type":"string","description":"Product type."},"qtyBackordered":{"type":"number","description":"Quantity backordered."},"qtyCanceled":{"type":"number","description":"Quantity canceled."},"qtyInvoiced":{"type":"number","description":"Quantity invoiced."},"qtyOrdered":{"type":"number","description":"Quantity ordered."},"qtyRefunded":{"type":"number","description":"Quantity refunded."},"qtyReturned":{"type":"number","description":"Quantity returned."},"qtyShipped":{"type":"number","description":"Quantity shipped."},"quoteItemId":{"type":"integer","description":"Quote item ID."},"rowInvoiced":{"type":"number","description":"Row invoiced."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"rowWeight":{"type":"number","description":"Row weight."},"sku":{"type":"string","description":"SKU."},"storeId":{"type":"integer","description":"Store ID."},"taxAmount":{"type":"number","description":"Tax amount."},"taxBeforeDiscount":{"type":"number","description":"Tax before discount."},"taxCanceled":{"type":"number","description":"Tax canceled."},"taxInvoiced":{"type":"number","description":"Tax invoiced."},"taxPercent":{"type":"number","description":"Tax percent."},"taxRefunded":{"type":"number","description":"Tax refunded."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weeeTaxApplied":{"type":"string","description":"WEEE tax applied."},"weeeTaxAppliedAmount":{"type":"number","description":"WEEE tax applied amount."},"weeeTaxAppliedRowAmount":{"type":"number","description":"WEEE tax applied row amount."},"weeeTaxDisposition":{"type":"number","description":"WEEE tax disposition."},"weeeTaxRowDisposition":{"type":"number","description":"WEEE tax row disposition."},"weight":{"type":"number","description":"Weight."},"parentItem":{"$ref":"#/definitions/sales-data-order-item-interface"},"productOption":{"$ref":"#/definitions/catalog-data-product-option-interface"},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-item-extension-interface"}},"required":["baseDiscountTaxCompensationAmount","baseDiscountTaxCompensationInvoiced","baseDiscountTaxCompensationRefunded","discountTaxCompensationAmount","discountTaxCompensationCanceled","discountTaxCompensationInvoiced","discountTaxCompensationRefunded","sku"]},"catalog-data-product-option-interface":{"type":"object","description":"Product option interface","properties":{"extensionAttributes":{"$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":{"customOptions":{"type":"array","items":{"$ref":"#/definitions/catalog-data-custom-option-interface"}},"bundleOptions":{"type":"array","items":{"$ref":"#/definitions/bundle-data-bundle-option-interface"}},"downloadableOption":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"configurableItemOptions":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-interface"}}}},"sales-data-order-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderItemInterface","properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}}},"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":{"addressType":{"type":"string","description":"Address type."},"city":{"type":"string","description":"City."},"company":{"type":"string","description":"Company."},"countryId":{"type":"string","description":"Country ID."},"customerAddressId":{"type":"integer","description":"Country address ID."},"customerId":{"type":"integer","description":"Customer ID."},"email":{"type":"string","description":"Email address."},"entityId":{"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."},"parentId":{"type":"integer","description":"Parent ID."},"postcode":{"type":"string","description":"Postal code."},"prefix":{"type":"string","description":"Prefix."},"region":{"type":"string","description":"Region."},"regionCode":{"type":"string","description":"Region code."},"regionId":{"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."},"vatId":{"type":"string","description":"VAT ID."},"vatIsValid":{"type":"integer","description":"VAT-is-valid flag value."},"vatRequestDate":{"type":"string","description":"VAT request date."},"vatRequestId":{"type":"string","description":"VAT request ID."},"vatRequestSuccess":{"type":"integer","description":"VAT-request-success flag value."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-address-extension-interface"}},"required":["addressType","city","countryId","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":{"accountStatus":{"type":"string","description":"Account status."},"additionalData":{"type":"string","description":"Additional data."},"additionalInformation":{"type":"array","description":"Array of additional information.","items":{"type":"string"}},"addressStatus":{"type":"string","description":"Address status."},"amountAuthorized":{"type":"number","description":"Amount authorized."},"amountCanceled":{"type":"number","description":"Amount canceled."},"amountOrdered":{"type":"number","description":"Amount ordered."},"amountPaid":{"type":"number","description":"Amount paid."},"amountRefunded":{"type":"number","description":"Amount refunded."},"anetTransMethod":{"type":"string","description":"Anet transaction method."},"baseAmountAuthorized":{"type":"number","description":"Base amount authorized."},"baseAmountCanceled":{"type":"number","description":"Base amount canceled."},"baseAmountOrdered":{"type":"number","description":"Base amount ordered."},"baseAmountPaid":{"type":"number","description":"Base amount paid."},"baseAmountPaidOnline":{"type":"number","description":"Base amount paid online."},"baseAmountRefunded":{"type":"number","description":"Base amount refunded."},"baseAmountRefundedOnline":{"type":"number","description":"Base amount refunded online."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingCaptured":{"type":"number","description":"Base shipping captured amount."},"baseShippingRefunded":{"type":"number","description":"Base shipping refunded amount."},"ccApproval":{"type":"string","description":"Credit card approval."},"ccAvsStatus":{"type":"string","description":"Credit card avs status."},"ccCidStatus":{"type":"string","description":"Credit card CID status."},"ccDebugRequestBody":{"type":"string","description":"Credit card debug request body."},"ccDebugResponseBody":{"type":"string","description":"Credit card debug response body."},"ccDebugResponseSerialized":{"type":"string","description":"Credit card debug response serialized."},"ccExpMonth":{"type":"string","description":"Credit card expiration month."},"ccExpYear":{"type":"string","description":"Credit card expiration year."},"ccLast4":{"type":"string","description":"Last four digits of the credit card."},"ccNumberEnc":{"type":"string","description":"Encrypted credit card number."},"ccOwner":{"type":"string","description":"Credit card number."},"ccSecureVerify":{"type":"string","description":"Credit card secure verify."},"ccSsIssue":{"type":"string","description":"Credit card SS issue."},"ccSsStartMonth":{"type":"string","description":"Credit card SS start month."},"ccSsStartYear":{"type":"string","description":"Credit card SS start year."},"ccStatus":{"type":"string","description":"Credit card status."},"ccStatusDescription":{"type":"string","description":"Credit card status description."},"ccTransId":{"type":"string","description":"Credit card transaction ID."},"ccType":{"type":"string","description":"Credit card type."},"echeckAccountName":{"type":"string","description":"eCheck account name."},"echeckAccountType":{"type":"string","description":"eCheck account type."},"echeckBankName":{"type":"string","description":"eCheck bank name."},"echeckRoutingNumber":{"type":"string","description":"eCheck routing number."},"echeckType":{"type":"string","description":"eCheck type."},"entityId":{"type":"integer","description":"Entity ID."},"lastTransId":{"type":"string","description":"Last transaction ID."},"method":{"type":"string","description":"Method."},"parentId":{"type":"integer","description":"Parent ID."},"poNumber":{"type":"string","description":"PO number."},"protectionEligibility":{"type":"string","description":"Protection eligibility."},"quotePaymentId":{"type":"integer","description":"Quote payment ID."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingCaptured":{"type":"number","description":"Shipping captured."},"shippingRefunded":{"type":"number","description":"Shipping refunded."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-payment-extension-interface"}},"required":["accountStatus","additionalInformation","ccLast4","method"]},"sales-data-order-payment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\OrderPaymentInterface"},"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."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Order status history ID."},"entityName":{"type":"string","description":"Entity name."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"status":{"type":"string","description":"Status."},"extensionAttributes":{"$ref":"#/definitions/sales-data-order-status-history-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"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":{"shippingAssignments":{"type":"array","items":{"$ref":"#/definitions/sales-data-shipping-assignment-interface"}},"appliedTaxes":{"type":"array","items":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-interface"}},"itemAppliedTaxes":{"type":"array","items":{"$ref":"#/definitions/tax-data-order-tax-details-item-interface"}},"convertingFromQuote":{"type":"boolean"},"giftMessage":{"$ref":"#/definitions/gift-message-data-message-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"}},"stockId":{"type":"integer","description":"Stock id"},"extensionAttributes":{"$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"},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipping-extension-interface"}}},"sales-data-total-interface":{"type":"object","description":"Interface TotalInterface","properties":{"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingCanceled":{"type":"number","description":"Base shipping canceled."},"baseShippingDiscountAmount":{"type":"number","description":"Base shipping discount amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Base shipping including tax."},"baseShippingInvoiced":{"type":"number","description":"Base shipping invoiced."},"baseShippingRefunded":{"type":"number","description":"Base shipping refunded."},"baseShippingTaxAmount":{"type":"number","description":"Base shipping tax amount."},"baseShippingTaxRefunded":{"type":"number","description":"Base shipping tax refunded."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingCanceled":{"type":"number","description":"Shipping canceled amount."},"shippingDiscountAmount":{"type":"number","description":"Shipping discount amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Shipping including tax amount."},"shippingInvoiced":{"type":"number","description":"Shipping invoiced amount."},"shippingRefunded":{"type":"number","description":"Shipping refunded amount."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount."},"shippingTaxRefunded":{"type":"number","description":"Shipping tax refunded amount."},"extensionAttributes":{"$ref":"#/definitions/sales-data-total-extension-interface"}},"required":["baseShippingDiscountTaxCompensationAmnt","shippingDiscountTaxCompensationAmount"]},"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"},"tax-data-order-tax-details-applied-tax-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Title"},"percent":{"type":"number","description":"Tax Percent"},"amount":{"type":"number","description":"Tax amount"},"baseAmount":{"type":"number","description":"Tax amount in base currency"},"extensionAttributes":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-extension-interface"}},"required":["amount","baseAmount"]},"tax-data-order-tax-details-applied-tax-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\OrderTaxDetailsAppliedTaxInterface"},"tax-data-order-tax-details-item-interface":{"type":"object","description":"","properties":{"type":{"type":"string","description":"Type (shipping, product, weee, gift wrapping, etc)"},"itemId":{"type":"integer","description":"Item id if this item is a product"},"associatedItemId":{"type":"integer","description":"Associated item id if this item is associated with another item, null otherwise"},"appliedTaxes":{"type":"array","description":"Applied taxes","items":{"$ref":"#/definitions/tax-data-order-tax-details-applied-tax-interface"}},"extensionAttributes":{"$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"},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-invoice-interface":{"type":"object","description":"Invoice interface. An invoice is a record of the receipt of payment for an order.","properties":{"baseCurrencyCode":{"type":"string","description":"Base currency code."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseGrandTotal":{"type":"number","description":"Base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"baseShippingAmount":{"type":"number","description":"Base shipping amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Base shipping including tax."},"baseShippingTaxAmount":{"type":"number","description":"Base shipping tax amount."},"baseSubtotal":{"type":"number","description":"Base subtotal."},"baseSubtotalInclTax":{"type":"number","description":"Base subtotal including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseTotalRefunded":{"type":"number","description":"Base total refunded."},"baseToGlobalRate":{"type":"number","description":"Base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Base-to-order rate."},"billingAddressId":{"type":"integer","description":"Billing address ID."},"canVoidFlag":{"type":"integer","description":"Can void flag value."},"createdAt":{"type":"string","description":"Created-at timestamp."},"discountAmount":{"type":"number","description":"Discount amount."},"discountDescription":{"type":"string","description":"Discount description."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Invoice ID."},"globalCurrencyCode":{"type":"string","description":"Global currency code."},"grandTotal":{"type":"number","description":"Grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"incrementId":{"type":"string","description":"Increment ID."},"isUsedForRefund":{"type":"integer","description":"Is-used-for-refund flag value."},"orderCurrencyCode":{"type":"string","description":"Order currency code."},"orderId":{"type":"integer","description":"Order ID."},"shippingAddressId":{"type":"integer","description":"Shipping address ID."},"shippingAmount":{"type":"number","description":"Shipping amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Shipping including tax."},"shippingTaxAmount":{"type":"number","description":"Shipping tax amount."},"state":{"type":"integer","description":"State."},"storeCurrencyCode":{"type":"string","description":"Store currency code."},"storeId":{"type":"integer","description":"Store ID."},"storeToBaseRate":{"type":"number","description":"Store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Store-to-order rate."},"subtotal":{"type":"number","description":"Subtotal."},"subtotalInclTax":{"type":"number","description":"Subtotal including tax."},"taxAmount":{"type":"number","description":"Tax amount."},"totalQty":{"type":"number","description":"Total quantity."},"transactionId":{"type":"string","description":"Transaction ID."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-extension-interface"}},"required":["baseDiscountTaxCompensationAmount","baseShippingDiscountTaxCompensationAmnt","discountTaxCompensationAmount","orderId","shippingDiscountTaxCompensationAmount","totalQty","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":{"additionalData":{"type":"string","description":"Additional data."},"baseCost":{"type":"number","description":"Base cost."},"baseDiscountAmount":{"type":"number","description":"Base discount amount."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Base discount tax compensation amount."},"basePrice":{"type":"number","description":"Base price."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"entityId":{"type":"integer","description":"Invoice item ID."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"name":{"type":"string","description":"Name."},"orderItemId":{"type":"integer","description":"Order item ID."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"qty":{"type":"number","description":"Quantity."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"sku":{"type":"string","description":"SKU."},"taxAmount":{"type":"number","description":"Tax amount."},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-item-extension-interface"}},"required":["baseDiscountTaxCompensationAmount","discountTaxCompensationAmount","orderItemId","qty","sku"]},"sales-data-invoice-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceItemInterface"},"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":{"comment":{"type":"string","description":"Comment."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Invoice ID."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-invoice-comment-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"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"},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-creditmemo-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Credit memo ID."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-comment-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"sales-data-creditmemo-comment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoCommentInterface"},"sales-data-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"adjustmentNegative":{"type":"number","description":"Credit memo negative adjustment."},"adjustmentPositive":{"type":"number","description":"Credit memo positive adjustment."},"baseAdjustment":{"type":"number","description":"Credit memo base adjustment."},"baseAdjustmentNegative":{"type":"number","description":"Credit memo negative base adjustment."},"baseAdjustmentPositive":{"type":"number","description":"Credit memo positive base adjustment."},"baseCurrencyCode":{"type":"string","description":"Credit memo base currency code."},"baseDiscountAmount":{"type":"number","description":"Credit memo base discount amount."},"baseGrandTotal":{"type":"number","description":"Credit memo base grand total."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"Credit memo base discount tax compensation amount."},"baseShippingAmount":{"type":"number","description":"Credit memo base shipping amount."},"baseShippingDiscountTaxCompensationAmnt":{"type":"number","description":"Credit memo base shipping discount tax compensation amount."},"baseShippingInclTax":{"type":"number","description":"Credit memo base shipping including tax."},"baseShippingTaxAmount":{"type":"number","description":"Credit memo base shipping tax amount."},"baseSubtotal":{"type":"number","description":"Credit memo base subtotal."},"baseSubtotalInclTax":{"type":"number","description":"Credit memo base subtotal including tax."},"baseTaxAmount":{"type":"number","description":"Credit memo base tax amount."},"baseToGlobalRate":{"type":"number","description":"Credit memo base-to-global rate."},"baseToOrderRate":{"type":"number","description":"Credit memo base-to-order rate."},"billingAddressId":{"type":"integer","description":"Credit memo billing address ID."},"createdAt":{"type":"string","description":"Credit memo created-at timestamp."},"creditmemoStatus":{"type":"integer","description":"Credit memo status."},"discountAmount":{"type":"number","description":"Credit memo discount amount."},"discountDescription":{"type":"string","description":"Credit memo discount description."},"emailSent":{"type":"integer","description":"Credit memo email sent flag value."},"entityId":{"type":"integer","description":"Credit memo ID."},"globalCurrencyCode":{"type":"string","description":"Credit memo global currency code."},"grandTotal":{"type":"number","description":"Credit memo grand total."},"discountTaxCompensationAmount":{"type":"number","description":"Credit memo discount tax compensation amount."},"incrementId":{"type":"string","description":"Credit memo increment ID."},"invoiceId":{"type":"integer","description":"Credit memo invoice ID."},"orderCurrencyCode":{"type":"string","description":"Credit memo order currency code."},"orderId":{"type":"integer","description":"Credit memo order ID."},"shippingAddressId":{"type":"integer","description":"Credit memo shipping address ID."},"shippingAmount":{"type":"number","description":"Credit memo shipping amount."},"shippingDiscountTaxCompensationAmount":{"type":"number","description":"Credit memo shipping discount tax compensation amount."},"shippingInclTax":{"type":"number","description":"Credit memo shipping including tax."},"shippingTaxAmount":{"type":"number","description":"Credit memo shipping tax amount."},"state":{"type":"integer","description":"Credit memo state."},"storeCurrencyCode":{"type":"string","description":"Credit memo store currency code."},"storeId":{"type":"integer","description":"Credit memo store ID."},"storeToBaseRate":{"type":"number","description":"Credit memo store-to-base rate."},"storeToOrderRate":{"type":"number","description":"Credit memo store-to-order rate."},"subtotal":{"type":"number","description":"Credit memo subtotal."},"subtotalInclTax":{"type":"number","description":"Credit memo subtotal including tax."},"taxAmount":{"type":"number","description":"Credit memo tax amount."},"transactionId":{"type":"string","description":"Credit memo transaction ID."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-extension-interface"}},"required":["baseDiscountTaxCompensationAmount","baseShippingDiscountTaxCompensationAmnt","discountTaxCompensationAmount","orderId","shippingDiscountTaxCompensationAmount","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":{"additionalData":{"type":"string","description":"Additional data."},"baseCost":{"type":"number","description":"The base cost for a credit memo item."},"baseDiscountAmount":{"type":"number","description":"The base discount amount for a credit memo item."},"baseDiscountTaxCompensationAmount":{"type":"number","description":"The base discount tax compensation amount for a credit memo item."},"basePrice":{"type":"number","description":"The base price for a credit memo item."},"basePriceInclTax":{"type":"number","description":"Base price including tax."},"baseRowTotal":{"type":"number","description":"Base row total."},"baseRowTotalInclTax":{"type":"number","description":"Base row total including tax."},"baseTaxAmount":{"type":"number","description":"Base tax amount."},"baseWeeeTaxAppliedAmount":{"type":"number","description":"Base WEEE tax applied amount."},"baseWeeeTaxAppliedRowAmnt":{"type":"number","description":"Base WEEE tax applied row amount."},"baseWeeeTaxDisposition":{"type":"number","description":"Base WEEE tax disposition."},"baseWeeeTaxRowDisposition":{"type":"number","description":"Base WEEE tax row disposition."},"description":{"type":"string","description":"Description."},"discountAmount":{"type":"number","description":"Discount amount."},"entityId":{"type":"integer","description":"Credit memo item ID."},"discountTaxCompensationAmount":{"type":"number","description":"Discount tax compensation amount."},"name":{"type":"string","description":"Name."},"orderItemId":{"type":"integer","description":"Order item ID."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"priceInclTax":{"type":"number","description":"Price including tax."},"productId":{"type":"integer","description":"Product ID."},"qty":{"type":"number","description":"Quantity."},"rowTotal":{"type":"number","description":"Row total."},"rowTotalInclTax":{"type":"number","description":"Row total including tax."},"sku":{"type":"string","description":"SKU."},"taxAmount":{"type":"number","description":"Tax amount."},"weeeTaxApplied":{"type":"string","description":"WEEE tax applied."},"weeeTaxAppliedAmount":{"type":"number","description":"WEEE tax applied amount."},"weeeTaxAppliedRowAmount":{"type":"number","description":"WEEE tax applied row amount."},"weeeTaxDisposition":{"type":"number","description":"WEEE tax disposition."},"weeeTaxRowDisposition":{"type":"number","description":"WEEE tax row disposition."},"extensionAttributes":{"$ref":"#/definitions/sales-data-creditmemo-item-extension-interface"}},"required":["baseCost","baseDiscountAmount","baseDiscountTaxCompensationAmount","basePrice","entityId","discountTaxCompensationAmount","orderItemId","qty"]},"sales-data-creditmemo-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoItemInterface"},"sales-data-creditmemo-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoInterface"},"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":{"billingAddressId":{"type":"integer","description":"Billing address ID."},"createdAt":{"type":"string","description":"Created-at timestamp."},"customerId":{"type":"integer","description":"Customer ID."},"emailSent":{"type":"integer","description":"Email-sent flag value."},"entityId":{"type":"integer","description":"Shipment ID."},"incrementId":{"type":"string","description":"Increment ID."},"orderId":{"type":"integer","description":"Order ID."},"packages":{"type":"array","description":"Array of packages, if any. Otherwise, null.","items":{"$ref":"#/definitions/sales-data-shipment-package-interface"}},"shipmentStatus":{"type":"integer","description":"Shipment status."},"shippingAddressId":{"type":"integer","description":"Shipping address ID."},"shippingLabel":{"type":"string","description":"Shipping label."},"storeId":{"type":"integer","description":"Store ID."},"totalQty":{"type":"number","description":"Total quantity."},"totalWeight":{"type":"number","description":"Total weight."},"updatedAt":{"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"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-extension-interface"}},"required":["orderId","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":{"extensionAttributes":{"$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":{"additionalData":{"type":"string","description":"Additional data."},"description":{"type":"string","description":"Description."},"entityId":{"type":"integer","description":"Shipment item ID."},"name":{"type":"string","description":"Name."},"orderItemId":{"type":"integer","description":"Order item ID."},"parentId":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"productId":{"type":"integer","description":"Product ID."},"qty":{"type":"number","description":"Quantity."},"rowTotal":{"type":"number","description":"Row total."},"sku":{"type":"string","description":"SKU."},"weight":{"type":"number","description":"Weight."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-item-extension-interface"}},"required":["orderItemId","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":{"carrierCode":{"type":"string","description":"Carrier code."},"createdAt":{"type":"string","description":"Created-at timestamp."},"description":{"type":"string","description":"Description."},"entityId":{"type":"integer","description":"Shipment package ID."},"orderId":{"type":"integer","description":"The order_id for the shipment package."},"parentId":{"type":"integer","description":"Parent ID."},"qty":{"type":"number","description":"Quantity."},"title":{"type":"string","description":"Title."},"trackNumber":{"type":"string","description":"Track number."},"updatedAt":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-track-extension-interface"}},"required":["carrierCode","description","orderId","parentId","qty","title","trackNumber","weight"]},"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":{"comment":{"type":"string","description":"Comment."},"createdAt":{"type":"string","description":"Created-at timestamp."},"entityId":{"type":"integer","description":"Shipment comment ID."},"isCustomerNotified":{"type":"integer","description":"Is-customer-notified flag value."},"isVisibleOnFront":{"type":"integer","description":"Is-visible-on-storefront flag value."},"parentId":{"type":"integer","description":"Parent ID."},"extensionAttributes":{"$ref":"#/definitions/sales-data-shipment-comment-extension-interface"}},"required":["comment","isCustomerNotified","isVisibleOnFront","parentId"]},"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"},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transactionId":{"type":"integer","description":"Transaction ID."},"parentId":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"orderId":{"type":"integer","description":"Order ID."},"paymentId":{"type":"integer","description":"Payment ID."},"txnId":{"type":"string","description":"Transaction business ID."},"parentTxnId":{"type":"string","description":"Parent transaction business ID."},"txnType":{"type":"string","description":"Transaction type."},"isClosed":{"type":"integer","description":"Is-closed flag value."},"additionalInformation":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"createdAt":{"type":"string","description":"Created-at timestamp."},"childTransactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extensionAttributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transactionId","orderId","paymentId","txnId","parentTxnId","txnType","isClosed","createdAt","childTransactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-inventory-data-stock-status-collection-interface":{"type":"object","description":"Stock Status collection interface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"searchCriteria":{"$ref":"#/definitions/catalog-inventory-stock-status-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"productId":{"type":"integer"},"stockId":{"type":"integer"},"qty":{"type":"integer"},"stockStatus":{"type":"integer"},"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extensionAttributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["productId","stockId","qty","stockStatus","stockItem"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"catalog-inventory-stock-status-criteria-interface":{"type":"object","description":"Interface StockStatusCriteriaInterface","properties":{"mapperInterfaceName":{"type":"string","description":"Associated Mapper Interface name"},"criteriaList":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapperInterfaceName","criteriaList","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapperInterfaceName":{"type":"string","description":"Associated Mapper Interface name"},"criteriaList":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapperInterfaceName","criteriaList","filters","orders","limit"]},"checkout-data-shipping-information-interface":{"type":"object","description":"","properties":{"shippingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"},"shippingMethodCode":{"type":"string","description":"Shipping method code"},"shippingCarrierCode":{"type":"string","description":"Carrier code"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-shipping-information-extension-interface"},"customAttributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["shippingAddress","shippingMethodCode","shippingCarrierCode"]},"checkout-data-shipping-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\ShippingInformationInterface"},"checkout-data-payment-details-interface":{"type":"object","description":"","properties":{"paymentMethods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["paymentMethods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"checkout-data-totals-information-interface":{"type":"object","description":"","properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"shippingMethodCode":{"type":"string","description":"Shipping method code"},"shippingCarrierCode":{"type":"string","description":"Carrier code"},"extensionAttributes":{"$ref":"#/definitions/checkout-data-totals-information-extension-interface"},"customAttributes":{"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":{"ruleId":{"type":"integer","description":"Rule id"},"name":{"type":"string","description":"Rule name"},"storeLabels":{"type":"array","description":"Display label","items":{"$ref":"#/definitions/sales-rule-data-rule-label-interface"}},"description":{"type":"string","description":"Description"},"websiteIds":{"type":"array","description":"A list of websites the rule applies to","items":{"type":"integer"}},"customerGroupIds":{"type":"array","description":"Ids of customer groups that the rule applies to","items":{"type":"integer"}},"fromDate":{"type":"string","description":"The start date when the coupon is active"},"toDate":{"type":"string","description":"The end date when the coupon is active"},"usesPerCustomer":{"type":"integer","description":"Number of uses per customer"},"isActive":{"type":"boolean","description":"The coupon is active"},"condition":{"$ref":"#/definitions/sales-rule-data-condition-interface"},"actionCondition":{"$ref":"#/definitions/sales-rule-data-condition-interface"},"stopRulesProcessing":{"type":"boolean","description":"To stop rule processing"},"isAdvanced":{"type":"boolean","description":"Is this field needed"},"productIds":{"type":"array","description":"Product ids","items":{"type":"integer"}},"sortOrder":{"type":"integer","description":"Sort order"},"simpleAction":{"type":"string","description":"Simple action of the rule"},"discountAmount":{"type":"number","description":"Discount amount"},"discountQty":{"type":"number","description":"Maximum qty discount is applied"},"discountStep":{"type":"integer","description":"Discount step"},"applyToShipping":{"type":"boolean","description":"The rule applies to shipping"},"timesUsed":{"type":"integer","description":"How many times the rule has been used"},"isRss":{"type":"boolean","description":"Whether the rule is in RSS"},"couponType":{"type":"string","description":"Coupon type"},"useAutoGeneration":{"type":"boolean","description":"To auto generate coupon"},"usesPerCoupon":{"type":"integer","description":"Limit of uses per coupon"},"simpleFreeShipping":{"type":"string","description":"To grant free shipping"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-rule-extension-interface"}},"required":["websiteIds","customerGroupIds","usesPerCustomer","isActive","stopRulesProcessing","isAdvanced","sortOrder","discountAmount","discountStep","applyToShipping","timesUsed","isRss","couponType","useAutoGeneration","usesPerCoupon"]},"sales-rule-data-rule-label-interface":{"type":"object","description":"Interface RuleLabelInterface","properties":{"storeId":{"type":"integer","description":"StoreId"},"storeLabel":{"type":"string","description":"The label for the store"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-rule-label-extension-interface"}},"required":["storeId","storeLabel"]},"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":{"conditionType":{"type":"string","description":"Condition type"},"conditions":{"type":"array","description":"List of conditions","items":{"$ref":"#/definitions/sales-rule-data-condition-interface"}},"aggregatorType":{"type":"string","description":"The aggregator type"},"operator":{"type":"string","description":"The operator of the condition"},"attributeName":{"type":"string","description":"The attribute name of the condition"},"value":{"type":"string","description":"The value of the condition"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-condition-extension-interface"}},"required":["conditionType","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"},"sales-rule-data-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-rule-data-coupon-interface":{"type":"object","description":"Interface CouponInterface","properties":{"couponId":{"type":"integer","description":"Coupon id"},"ruleId":{"type":"integer","description":"The id of the rule associated with the coupon"},"code":{"type":"string","description":"Coupon code"},"usageLimit":{"type":"integer","description":"Usage limit"},"usagePerCustomer":{"type":"integer","description":"Usage limit per customer"},"timesUsed":{"type":"integer","description":"The number of times the coupon has been used"},"expirationDate":{"type":"string","description":"Expiration date"},"isPrimary":{"type":"boolean","description":"The coupon is primary coupon for the rule that it's associated with"},"createdAt":{"type":"string","description":"When the coupon is created"},"type":{"type":"integer","description":"Of coupon"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-coupon-extension-interface"}},"required":["ruleId","timesUsed","isPrimary"]},"sales-rule-data-coupon-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\CouponInterface"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"sales-rule-data-coupon-generation-spec-interface":{"type":"object","description":"CouponGenerationSpecInterface","properties":{"ruleId":{"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"},"delimiterAtEvery":{"type":"integer","description":"The spacing where the delimiter should exist"},"delimiter":{"type":"string","description":"The delimiter"},"extensionAttributes":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-extension-interface"}},"required":["ruleId","format","quantity","length"]},"sales-rule-data-coupon-generation-spec-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\SalesRule\\Api\\Data\\CouponGenerationSpecInterface"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failedItems":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missingItems":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failedItems","missingItems"]},"tax-data-tax-rate-interface":{"type":"object","description":"Tax rate interface.","properties":{"id":{"type":"integer","description":"Id"},"taxCountryId":{"type":"string","description":"Country id"},"taxRegionId":{"type":"integer","description":"Region id"},"regionName":{"type":"string","description":"Region name"},"taxPostcode":{"type":"string","description":"Postcode"},"zipIsRange":{"type":"integer","description":"Zip is range"},"zipFrom":{"type":"integer","description":"Zip range from"},"zipTo":{"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"}},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rate-extension-interface"}},"required":["taxCountryId","rate","code"]},"tax-data-tax-rate-title-interface":{"type":"object","description":"Tax rate title interface.","properties":{"storeId":{"type":"string","description":"Store id"},"value":{"type":"string","description":"Title value"},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rate-title-extension-interface"}},"required":["storeId","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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"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."},"customerTaxClassIds":{"type":"array","description":"Customer tax class id","items":{"type":"integer"}},"productTaxClassIds":{"type":"array","description":"Product tax class id","items":{"type":"integer"}},"taxRateIds":{"type":"array","description":"Tax rate ids","items":{"type":"integer"}},"calculateSubtotal":{"type":"boolean","description":"Calculate subtotal."},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-rule-extension-interface"}},"required":["code","priority","position","customerTaxClassIds","productTaxClassIds","taxRateIds"]},"tax-data-tax-rule-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxRuleInterface"},"tax-data-tax-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]},"tax-data-tax-class-interface":{"type":"object","description":"Tax class interface.","properties":{"classId":{"type":"integer","description":"Tax class ID."},"className":{"type":"string","description":"Tax class name."},"classType":{"type":"string","description":"Tax class type."},"extensionAttributes":{"$ref":"#/definitions/tax-data-tax-class-extension-interface"}},"required":["className","classType"]},"tax-data-tax-class-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Tax\\Api\\Data\\TaxClassInterface"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"searchCriteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"totalCount":{"type":"integer","description":"Total count."}},"required":["items","searchCriteria","totalCount"]}}} diff --git a/src/swagger/schemas/original-2.1.schema.json b/src/swagger/schemas/original-2.1.schema.json deleted file mode 100644 index c9dca414f1c..00000000000 --- a/src/swagger/schemas/original-2.1.schema.json +++ /dev/null @@ -1,4 +0,0 @@ - - -{"swagger":"2.0","info":{"version":"2.1","title":"Magento Community"},"host":"magento.vg","basePath":"/rest/default","schemes":["http"],"tags":[{"name":"storeStoreRepositoryV1","description":"Store repository interface"},{"name":"storeGroupRepositoryV1","description":"Group repository interface"},{"name":"storeWebsiteRepositoryV1","description":"Website repository interface"},{"name":"storeStoreConfigManagerV1","description":"Store config manager interface"},{"name":"directoryCurrencyInformationAcquirerV1","description":"Currency information acquirer interface"},{"name":"directoryCountryInformationAcquirerV1","description":"Country information acquirer interface"},{"name":"backendModuleServiceV1","description":"Interface for module service."},{"name":"eavAttributeSetRepositoryV1","description":"Interface AttributeSetRepositoryInterface"},{"name":"eavAttributeSetManagementV1","description":"Interface AttributeSetManagementInterface"},{"name":"customerGroupRepositoryV1","description":"Customer group CRUD interface"},{"name":"customerGroupManagementV1","description":"Interface for managing customer groups."},{"name":"customerCustomerMetadataV1","description":"Interface for retrieval information about customer attributes metadata."},{"name":"customerAddressMetadataV1","description":"Interface for retrieval information about customer address attributes metadata."},{"name":"customerCustomerRepositoryV1","description":"Customer CRUD interface."},{"name":"customerAccountManagementV1","description":"Interface for managing customers accounts."},{"name":"customerAddressRepositoryV1","description":"Customer address CRUD interface."},{"name":"cmsPageRepositoryV1","description":"CMS page CRUD interface."},{"name":"cmsBlockRepositoryV1","description":"CMS block CRUD interface."},{"name":"catalogProductRepositoryV1","description":""},{"name":"catalogProductAttributeTypesListV1","description":""},{"name":"catalogProductAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeRepositoryV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogCategoryAttributeOptionManagementV1","description":"Interface RepositoryInterface must be implemented in new model"},{"name":"catalogProductTypeListV1","description":""},{"name":"catalogAttributeSetRepositoryV1","description":""},{"name":"catalogAttributeSetManagementV1","description":""},{"name":"catalogProductAttributeManagementV1","description":""},{"name":"catalogProductAttributeGroupRepositoryV1","description":""},{"name":"catalogProductAttributeOptionManagementV1","description":""},{"name":"catalogProductMediaAttributeManagementV1","description":""},{"name":"catalogProductAttributeMediaGalleryManagementV1","description":""},{"name":"catalogProductTierPriceManagementV1","description":""},{"name":"catalogCategoryRepositoryV1","description":""},{"name":"catalogCategoryManagementV1","description":""},{"name":"catalogProductCustomOptionTypeListV1","description":""},{"name":"catalogProductCustomOptionRepositoryV1","description":""},{"name":"catalogProductLinkTypeListV1","description":""},{"name":"catalogProductLinkManagementV1","description":""},{"name":"catalogProductLinkRepositoryV1","description":"Interface Product links handling interface"},{"name":"catalogCategoryLinkManagementV1","description":""},{"name":"catalogCategoryLinkRepositoryV1","description":""},{"name":"catalogProductWebsiteLinkRepositoryV1","description":"Interface ProductWebsiteLinkRepositoryInterface"},{"name":"searchV1","description":"Search API for all requests"},{"name":"bundleProductLinkManagementV1","description":"Interface for Management of ProductLink"},{"name":"bundleProductOptionRepositoryV1","description":"Interface ProductOptionRepositoryInterface"},{"name":"bundleProductOptionTypeListV1","description":"Interface ProductOptionTypeListInterface"},{"name":"bundleProductOptionManagementV1","description":"Option manager for bundle products"},{"name":"quoteCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"quoteCartManagementV1","description":"Interface CartManagementInterface"},{"name":"quoteGuestCartRepositoryV1","description":"Cart Repository interface for guest carts."},{"name":"quoteGuestCartManagementV1","description":"Cart Management interface for guest carts."},{"name":"quoteShippingMethodManagementV1","description":"Interface ShippingMethodManagementInterface"},{"name":"quoteShipmentEstimationV1","description":"Interface ShipmentManagementInterface"},{"name":"quoteGuestShippingMethodManagementV1","description":"Shipping method management interface for guest carts."},{"name":"quoteGuestShipmentEstimationV1","description":"Interface GuestShipmentEstimationInterface"},{"name":"quoteCartItemRepositoryV1","description":"Interface CartItemRepositoryInterface"},{"name":"quoteGuestCartItemRepositoryV1","description":"Cart Item repository interface for guest carts."},{"name":"quotePaymentMethodManagementV1","description":"Interface PaymentMethodManagementInterface"},{"name":"quoteGuestPaymentMethodManagementV1","description":"Payment method management interface for guest carts."},{"name":"quoteBillingAddressManagementV1","description":"Interface BillingAddressManagementInterface"},{"name":"quoteGuestBillingAddressManagementV1","description":"Billing address management interface for guest carts."},{"name":"quoteCouponManagementV1","description":"Coupon management service interface."},{"name":"quoteGuestCouponManagementV1","description":"Coupon management interface for guest carts."},{"name":"quoteCartTotalRepositoryV1","description":"Interface CartTotalRepositoryInterface"},{"name":"quoteGuestCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"quoteGuestCartTotalRepositoryV1","description":"Cart totals repository interface for guest carts."},{"name":"quoteCartTotalManagementV1","description":"Bundled API to collect totals for cart based on shipping/payment methods and additional data."},{"name":"checkoutAgreementsCheckoutAgreementsRepositoryV1","description":"Interface CheckoutAgreementsRepositoryInterface"},{"name":"downloadableLinkRepositoryV1","description":"Interface LinkRepositoryInterface"},{"name":"downloadableSampleRepositoryV1","description":"Interface SampleRepositoryInterface"},{"name":"catalogInventoryStockRegistryV1","description":"Interface StockRegistryInterface"},{"name":"salesOrderRepositoryV1","description":"Order repository 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."},{"name":"salesOrderManagementV1","description":"Order management 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."},{"name":"salesOrderAddressRepositoryV1","description":"Order address repository 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."},{"name":"salesOrderItemRepositoryV1","description":"Order item repository 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."},{"name":"salesInvoiceRepositoryV1","description":"Invoice repository interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceManagementV1","description":"Invoice management interface. An invoice is a record of the receipt of payment for an order."},{"name":"salesInvoiceCommentRepositoryV1","description":"Invoice comment repository interface. An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the invoice history."},{"name":"salesCreditmemoManagementV1","description":"Credit memo add 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."},{"name":"salesCreditmemoRepositoryV1","description":"Credit memo repository 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."},{"name":"salesCreditmemoCommentRepositoryV1","description":"Credit memo comment repository 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."},{"name":"salesShipmentRepositoryV1","description":"Shipment repository 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."},{"name":"salesShipmentManagementV1","description":"Shipment management 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."},{"name":"salesShipmentCommentRepositoryV1","description":"Shipment comment repository 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."},{"name":"salesShipmentTrackRepositoryV1","description":"Shipment track repository 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."},{"name":"salesTransactionRepositoryV1","description":"Transaction repository interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on."},{"name":"giftMessageCartRepositoryV1","description":"Interface CartRepositoryInterface"},{"name":"giftMessageItemRepositoryV1","description":"Interface ItemRepositoryInterface"},{"name":"giftMessageGuestCartRepositoryV1","description":"Interface GuestCartRepositoryInterface"},{"name":"giftMessageGuestItemRepositoryV1","description":"Interface GuestItemRepositoryInterface"},{"name":"checkoutGuestShippingInformationManagementV1","description":"Interface for managing guest shipping address information"},{"name":"checkoutShippingInformationManagementV1","description":"Interface for managing customer shipping address information"},{"name":"checkoutTotalsInformationManagementV1","description":"Interface for quote totals calculation"},{"name":"checkoutGuestTotalsInformationManagementV1","description":"Interface for guest quote totals calculation"},{"name":"checkoutGuestPaymentInformationManagementV1","description":"Interface for managing guest payment information"},{"name":"checkoutPaymentInformationManagementV1","description":"Interface for managing quote payment information"},{"name":"taxTaxRateRepositoryV1","description":"Tax rate CRUD interface."},{"name":"taxTaxRuleRepositoryV1","description":"Tax rule CRUD interface."},{"name":"taxTaxClassRepositoryV1","description":"Tax class CRUD interface."},{"name":"configurableProductLinkManagementV1","description":"Manage children products of configurable product"},{"name":"configurableProductConfigurableProductManagementV1","description":"Interface ConfigurableProductManagementInterface"},{"name":"configurableProductOptionRepositoryV1","description":"Manage options of configurable product"},{"name":"salesRuleRuleRepositoryV1","description":"Sales rule CRUD interface"},{"name":"salesRuleCouponRepositoryV1","description":"Coupon CRUD interface"},{"name":"salesRuleCouponManagementV1","description":"Coupon management interface"},{"name":"integrationAdminTokenServiceV1","description":"Interface providing token generation for Admins"},{"name":"integrationCustomerTokenServiceV1","description":"Interface providing token generation for Customers"}],"paths":{"/V1/store/storeViews":{"get":{"tags":["storeStoreRepositoryV1"],"description":"Retrieve list of all stores","operationId":"storeStoreRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeGroups":{"get":{"tags":["storeGroupRepositoryV1"],"description":"Retrieve list of all groups","operationId":"storeGroupRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-group-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/websites":{"get":{"tags":["storeWebsiteRepositoryV1"],"description":"Retrieve list of all websites","operationId":"storeWebsiteRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-website-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/store/storeConfigs":{"get":{"tags":["storeStoreConfigManagerV1"],"description":"","operationId":"storeStoreConfigManagerV1GetStoreConfigsGet","parameters":[{"name":"storeCodes","in":"query","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/store-data-store-config-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/currency":{"get":{"tags":["directoryCurrencyInformationAcquirerV1"],"description":"Get currency information for the store.","operationId":"directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-currency-information-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get all countries and regions information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountriesInfoGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/directory-data-country-information-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/directory/countries/{countryId}":{"get":{"tags":["directoryCountryInformationAcquirerV1"],"description":"Get country and region information for the store.","operationId":"directoryCountryInformationAcquirerV1GetCountryInfoGet","parameters":[{"name":"countryId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/directory-data-country-information-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/modules":{"get":{"tags":["backendModuleServiceV1"],"description":"Returns an array of enabled modules","operationId":"backendModuleServiceV1GetModulesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/list":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"eavAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets/{attributeSetId}":{"get":{"tags":["eavAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"eavAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["eavAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"eavAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["eavAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"eavAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/eav/attribute-sets":{"post":{"tags":["eavAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"eavAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entityTypeCode","attributeSet","skeletonId"],"properties":{"entityTypeCode":{"type":"string"},"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Get customer group by group ID.","operationId":"customerGroupRepositoryV1GetByIdGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerGroupRepositoryV1"],"description":"Delete customer group by ID.","operationId":"customerGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/search":{"get":{"tags":["customerGroupRepositoryV1"],"description":"Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups":{"post":{"tags":["customerGroupRepositoryV1"],"description":"Save customer group.","operationId":"customerGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/customer-data-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default/{storeId}":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/default":{"get":{"tags":["customerGroupManagementV1"],"description":"Get default customer group.","operationId":"customerGroupManagementV1GetDefaultGroupGet","parameters":[{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customerGroups/{id}/permissions":{"get":{"tags":["customerGroupManagementV1"],"description":"Check if customer group can be deleted.","operationId":"customerGroupManagementV1IsReadonlyGet","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/attribute/{attributeCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerCustomerMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/form/{formCode}":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerCustomerMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerCustomerMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customer/custom":{"get":{"tags":["customerCustomerMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerCustomerMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/attribute/{attributeCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve attribute metadata.","operationId":"customerAddressMetadataV1GetAttributeMetadataGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/form/{formCode}":{"get":{"tags":["customerAddressMetadataV1"],"description":"Retrieve all attributes filtered by form code","operationId":"customerAddressMetadataV1GetAttributesGet","parameters":[{"name":"formCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get all attribute metadata.","operationId":"customerAddressMetadataV1GetAllAttributesMetadataGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/attributeMetadata/customerAddress/custom":{"get":{"tags":["customerAddressMetadataV1"],"description":"Get custom attributes metadata for the given data interface.","operationId":"customerAddressMetadataV1GetCustomAttributesMetadataGet","parameters":[{"name":"dataInterfaceName","in":"query","type":"string","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/customer-data-attribute-metadata-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["customerCustomerRepositoryV1"],"description":"Delete customer by ID.","operationId":"customerCustomerRepositoryV1DeleteByIdDelete","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{id}":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me":{"put":{"tags":["customerCustomerRepositoryV1"],"description":"Create or update a customer.","operationId":"customerCustomerRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"passwordHash":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["customerCustomerRepositoryV1"],"description":"Get customer by customer ID.","operationId":"customerCustomerRepositoryV1GetByIdGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/search":{"get":{"tags":["customerCustomerRepositoryV1"],"description":"Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"customerCustomerRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers":{"post":{"tags":["customerAccountManagementV1"],"description":"Create customer account. Perform necessary business operations like sending email.","operationId":"customerAccountManagementV1CreateAccountPost","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"},"password":{"type":"string"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivateByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{email}/activate":{"put":{"tags":["customerAccountManagementV1"],"description":"Activate a customer account using a key that was sent in a confirmation email.","operationId":"customerAccountManagementV1ActivatePut","parameters":[{"name":"email","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["confirmationKey"],"properties":{"confirmationKey":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-customer-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Change customer password.","operationId":"customerAccountManagementV1ChangePasswordByIdPut","parameters":[{"name":"$body","in":"body","schema":{"required":["currentPassword","newPassword"],"properties":{"currentPassword":{"type":"string"},"newPassword":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/password/resetLinkToken/{resetPasswordLinkToken}":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if password reset token is valid.","operationId":"customerAccountManagementV1ValidateResetPasswordLinkTokenGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true},{"name":"resetPasswordLinkToken","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the token is valid"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/password":{"put":{"tags":["customerAccountManagementV1"],"description":"Send an email to the customer with a password reset link.","operationId":"customerAccountManagementV1InitiatePasswordResetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["email","template"],"properties":{"email":{"type":"string"},"template":{"type":"string"},"websiteId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/confirm":{"get":{"tags":["customerAccountManagementV1"],"description":"Gets the account confirmation status.","operationId":"customerAccountManagementV1GetConfirmationStatusGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/confirm":{"post":{"tags":["customerAccountManagementV1"],"description":"Resend confirmation email.","operationId":"customerAccountManagementV1ResendConfirmationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["email","websiteId"],"properties":{"email":{"type":"string"},"websiteId":{"type":"integer"},"redirectUrl":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/validate":{"put":{"tags":["customerAccountManagementV1"],"description":"Validate customer data.","operationId":"customerAccountManagementV1ValidatePut","parameters":[{"name":"$body","in":"body","schema":{"required":["customer"],"properties":{"customer":{"$ref":"#/definitions/customer-data-customer-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-validation-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/permissions/readonly":{"get":{"tags":["customerAccountManagementV1"],"description":"Check if customer can be deleted.","operationId":"customerAccountManagementV1IsReadonlyGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/isEmailAvailable":{"post":{"tags":["customerAccountManagementV1"],"description":"Check if given email is associated with a customer account in given website.","operationId":"customerAccountManagementV1IsEmailAvailablePost","parameters":[{"name":"$body","in":"body","schema":{"required":["customerEmail"],"properties":{"customerEmail":{"type":"string"},"websiteId":{"type":"integer","description":"If not set, will use the current websiteId"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/billingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default billing address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultBillingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/me/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/shippingAddress":{"get":{"tags":["customerAccountManagementV1"],"description":"Retrieve default shipping address for the given customerId.","operationId":"customerAccountManagementV1GetDefaultShippingAddressGet","parameters":[{"name":"customerId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/addresses/{addressId}":{"get":{"tags":["customerAddressRepositoryV1"],"description":"Retrieve customer address.","operationId":"customerAddressRepositoryV1GetByIdGet","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/customer-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/addresses/{addressId}":{"delete":{"tags":["customerAddressRepositoryV1"],"description":"Delete customer address by ID.","operationId":"customerAddressRepositoryV1DeleteByIdDelete","parameters":[{"name":"addressId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{pageId}":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve page.","operationId":"cmsPageRepositoryV1GetByIdGet","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsPageRepositoryV1"],"description":"Delete page by ID.","operationId":"cmsPageRepositoryV1DeleteByIdDelete","parameters":[{"name":"pageId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/search":{"get":{"tags":["cmsPageRepositoryV1"],"description":"Retrieve pages matching the specified criteria.","operationId":"cmsPageRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage":{"post":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsPage/{id}":{"put":{"tags":["cmsPageRepositoryV1"],"description":"Save page.","operationId":"cmsPageRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["page"],"properties":{"page":{"$ref":"#/definitions/cms-data-page-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-page-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{blockId}":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve block.","operationId":"cmsBlockRepositoryV1GetByIdGet","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["cmsBlockRepositoryV1"],"description":"Delete block by ID.","operationId":"cmsBlockRepositoryV1DeleteByIdDelete","parameters":[{"name":"blockId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/search":{"get":{"tags":["cmsBlockRepositoryV1"],"description":"Retrieve blocks matching the specified criteria.","operationId":"cmsBlockRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock":{"post":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/cmsBlock/{id}":{"put":{"tags":["cmsBlockRepositoryV1"],"description":"Save block.","operationId":"cmsBlockRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["block"],"properties":{"block":{"$ref":"#/definitions/cms-data-block-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/cms-data-block-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products":{"post":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get product list","operationId":"catalogProductRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}":{"put":{"tags":["catalogProductRepositoryV1"],"description":"Create product","operationId":"catalogProductRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["product"],"properties":{"product":{"$ref":"#/definitions/catalog-data-product-interface"},"saveOptions":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductRepositoryV1"],"description":"","operationId":"catalogProductRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductRepositoryV1"],"description":"Get info about product by product SKU","operationId":"catalogProductRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"editMode","in":"query","type":"boolean","required":false},{"name":"storeId","in":"query","type":"integer","required":false},{"name":"forceReload","in":"query","type":"boolean","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/types":{"get":{"tags":["catalogProductAttributeTypesListV1"],"description":"Retrieve list of product attribute types","operationId":"catalogProductAttributeTypesListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogProductAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePut","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Delete Attribute by id","operationId":"catalogProductAttributeRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes":{"get":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogProductAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeRepositoryV1"],"description":"Save attribute data","operationId":"catalogProductAttributeRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attribute"],"properties":{"attribute":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve specific attribute","operationId":"catalogCategoryAttributeRepositoryV1GetGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes":{"get":{"tags":["catalogCategoryAttributeRepositoryV1"],"description":"Retrieve all attributes for entity type","operationId":"catalogCategoryAttributeRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-attribute-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/attributes/{attributeCode}/options":{"get":{"tags":["catalogCategoryAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogCategoryAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/types":{"get":{"tags":["catalogProductTypeListV1"],"description":"Retrieve available product types","operationId":"catalogProductTypeListV1GetProductTypesGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/sets/list":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve list of Attribute Sets","operationId":"catalogAttributeSetRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}":{"get":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Retrieve attribute set information based on given ID","operationId":"catalogAttributeSetRepositoryV1GetGet","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Remove attribute set by given ID","operationId":"catalogAttributeSetRepositoryV1DeleteByIdDelete","parameters":[{"name":"attributeSetId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogAttributeSetRepositoryV1"],"description":"Save attribute set data","operationId":"catalogAttributeSetRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["attributeSet"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets":{"post":{"tags":["catalogAttributeSetManagementV1"],"description":"Create attribute set from data","operationId":"catalogAttributeSetManagementV1CreatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSet","skeletonId"],"properties":{"attributeSet":{"$ref":"#/definitions/eav-data-attribute-set-interface"},"skeletonId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes":{"get":{"tags":["catalogProductAttributeManagementV1"],"description":"Retrieve related attributes based on given attribute set ID","operationId":"catalogProductAttributeManagementV1GetAttributesGet","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/attributes":{"post":{"tags":["catalogProductAttributeManagementV1"],"description":"Assign attribute to attribute set","operationId":"catalogProductAttributeManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["attributeSetId","attributeGroupId","attributeCode","sortOrder"],"properties":{"attributeSetId":{"type":"integer"},"attributeGroupId":{"type":"integer"},"attributeCode":{"type":"string"},"sortOrder":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/attributes/{attributeCode}":{"delete":{"tags":["catalogProductAttributeManagementV1"],"description":"Remove attribute from attribute set","operationId":"catalogProductAttributeManagementV1UnassignDelete","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/list":{"get":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Retrieve list of attribute groups","operationId":"catalogProductAttributeGroupRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups":{"post":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/{attributeSetId}/groups":{"put":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Save attribute group","operationId":"catalogProductAttributeGroupRepositoryV1SavePut","parameters":[{"name":"attributeSetId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["group"],"properties":{"group":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attribute-sets/groups/{groupId}":{"delete":{"tags":["catalogProductAttributeGroupRepositoryV1"],"description":"Remove attribute group by id","operationId":"catalogProductAttributeGroupRepositoryV1DeleteByIdDelete","parameters":[{"name":"groupId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options":{"get":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Retrieve list of attribute options","operationId":"catalogProductAttributeOptionManagementV1GetItemsGet","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/eav-data-attribute-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Add option to attribute","operationId":"catalogProductAttributeOptionManagementV1AddPost","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/eav-data-attribute-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/attributes/{attributeCode}/options/{optionId}":{"delete":{"tags":["catalogProductAttributeOptionManagementV1"],"description":"Delete option from attribute","operationId":"catalogProductAttributeOptionManagementV1DeleteDelete","parameters":[{"name":"attributeCode","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/media/types/{attributeSetName}":{"get":{"tags":["catalogProductMediaAttributeManagementV1"],"description":"Retrieve the list of media attributes (fronted input type is media_image) assigned to the given attribute set.","operationId":"catalogProductMediaAttributeManagementV1GetListGet","parameters":[{"name":"attributeSetName","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"list of media attributes","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media/{entryId}":{"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Return information about gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Update gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1UpdatePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Remove gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1RemoveDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"entryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/media":{"post":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Create new gallery entry","operationId":"catalogProductAttributeMediaGalleryManagementV1CreatePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entry"],"properties":{"entry":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"gallery entry ID"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogProductAttributeMediaGalleryManagementV1"],"description":"Retrieve the list of gallery entries associated with given product","operationId":"catalogProductAttributeMediaGalleryManagementV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-attribute-media-gallery-entry-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers":{"get":{"tags":["catalogProductTierPriceManagementV1"],"description":"Get tier price of product","operationId":"catalogProductTierPriceManagementV1GetListGet","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'"}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-tier-price-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}/price/{price}":{"post":{"tags":["catalogProductTierPriceManagementV1"],"description":"Create tier price for product","operationId":"catalogProductTierPriceManagementV1AddPost","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/group-prices/{customerGroupId}/tiers/{qty}":{"delete":{"tags":["catalogProductTierPriceManagementV1"],"description":"Remove tier price from product","operationId":"catalogProductTierPriceManagementV1RemoveDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}":{"delete":{"tags":["catalogCategoryRepositoryV1"],"description":"Delete category by identifier","operationId":"catalogCategoryRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"Will returned True if deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryRepositoryV1"],"description":"Get info about category by category id","operationId":"catalogCategoryRepositoryV1GetGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"storeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories":{"post":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["catalogCategoryManagementV1"],"description":"Retrieve list of categories","operationId":"catalogCategoryManagementV1GetTreeGet","parameters":[{"name":"rootCategoryId","in":"query","type":"integer","required":false},{"name":"depth","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-tree-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{id}":{"put":{"tags":["catalogCategoryRepositoryV1"],"description":"Create category service","operationId":"catalogCategoryRepositoryV1SavePut","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["category"],"properties":{"category":{"$ref":"#/definitions/catalog-data-category-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-category-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/move":{"put":{"tags":["catalogCategoryManagementV1"],"description":"Move category","operationId":"catalogCategoryManagementV1MovePut","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["parentId"],"properties":{"parentId":{"type":"integer"},"afterId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/types":{"get":{"tags":["catalogProductCustomOptionTypeListV1"],"description":"Get custom option types","operationId":"catalogProductCustomOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get the list of custom options for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/options/{optionId}":{"get":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Get custom option for a specific product","operationId":"catalogProductCustomOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"","operationId":"catalogProductCustomOptionRepositoryV1DeleteByIdentifierDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options":{"post":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/options/{optionId}":{"put":{"tags":["catalogProductCustomOptionRepositoryV1"],"description":"Save Custom Option","operationId":"catalogProductCustomOptionRepositoryV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-data-product-custom-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/types":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Retrieve information about available product link types","operationId":"catalogProductLinkTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/links/{type}/attributes":{"get":{"tags":["catalogProductLinkTypeListV1"],"description":"Provide a list of the product link type attributes","operationId":"catalogProductLinkTypeListV1GetItemAttributesGet","parameters":[{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-attribute-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}":{"get":{"tags":["catalogProductLinkManagementV1"],"description":"Provide the list of links for a specific product","operationId":"catalogProductLinkManagementV1GetLinkedItemsByTypeGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"type","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links":{"post":{"tags":["catalogProductLinkManagementV1"],"description":"Assign a product link to another product","operationId":"catalogProductLinkManagementV1SetProductLinksPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-link-interface"}}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductLinkRepositoryV1"],"description":"Save product link","operationId":"catalogProductLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/catalog-data-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/links/{type}/{linkedProductSku}":{"delete":{"tags":["catalogProductLinkRepositoryV1"],"description":"","operationId":"catalogProductLinkRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products":{"get":{"tags":["catalogCategoryLinkManagementV1"],"description":"Get products assigned to category","operationId":"catalogCategoryLinkManagementV1GetAssignedProductsGet","parameters":[{"name":"categoryId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePost","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Assign a product to the required category","operationId":"catalogCategoryLinkRepositoryV1SavePut","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productLink"],"properties":{"productLink":{"$ref":"#/definitions/catalog-data-category-product-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if assigned"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/categories/{categoryId}/products/{sku}":{"delete":{"tags":["catalogCategoryLinkRepositoryV1"],"description":"Remove the product assignment from the category by category id and sku","operationId":"catalogCategoryLinkRepositoryV1DeleteByIdsDelete","parameters":[{"name":"categoryId","in":"path","type":"string","required":true},{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if products successfully deleted"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites":{"post":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Assign a product to the website","operationId":"catalogProductWebsiteLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["productWebsiteLink"],"properties":{"productWebsiteLink":{"$ref":"#/definitions/catalog-data-product-website-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully assigned to product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/websites/{websiteId}":{"delete":{"tags":["catalogProductWebsiteLinkRepositoryV1"],"description":"Remove the website assignment from the product by product sku","operationId":"catalogProductWebsiteLinkRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"websiteId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"will returned True if website successfully unassigned from product"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/search":{"get":{"tags":["searchV1"],"description":"Make Full Text Search and return found Documents","operationId":"searchV1SearchGet","parameters":[{"name":"searchCriteria[requestName]","in":"query","type":"string"},{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/framework-search-search-result-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{optionId}":{"post":{"tags":["bundleProductLinkManagementV1"],"description":"Add child product to specified Bundle option by product sku","operationId":"bundleProductLinkManagementV1AddChildByProductSkuPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/links/{id}":{"put":{"tags":["bundleProductLinkManagementV1"],"description":"","operationId":"bundleProductLinkManagementV1SaveChildPut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["linkedProduct"],"properties":{"linkedProduct":{"$ref":"#/definitions/bundle-data-link-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{productSku}/children":{"get":{"tags":["bundleProductLinkManagementV1"],"description":"Get all children for Bundle product","operationId":"bundleProductLinkManagementV1GetChildrenGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"optionId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}/children/{childSku}":{"delete":{"tags":["bundleProductLinkManagementV1"],"description":"Remove product from Bundle product option","operationId":"bundleProductLinkManagementV1RemoveChildDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/all":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get all options for bundle product","operationId":"bundleProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/{sku}/options/{optionId}":{"get":{"tags":["bundleProductOptionRepositoryV1"],"description":"Get option for bundle product","operationId":"bundleProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/bundle-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["bundleProductOptionRepositoryV1"],"description":"Remove bundle option","operationId":"bundleProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"optionId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/types":{"get":{"tags":["bundleProductOptionTypeListV1"],"description":"Get all types for options for bundle products","operationId":"bundleProductOptionTypeListV1GetItemsGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-type-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/add":{"post":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/bundle-products/options/{optionId}":{"put":{"tags":["bundleProductOptionManagementV1"],"description":"Add new option for bundle product","operationId":"bundleProductOptionManagementV1SavePut","parameters":[{"name":"optionId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/bundle-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables an administrative user to return information for a specified cart.","operationId":"quoteCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteCartManagementV1"],"description":"Assigns a specified customer to a specified shopping cart.","operationId":"quoteCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/search":{"get":{"tags":["quoteCartRepositoryV1"],"description":"Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteCartRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine":{"put":{"tags":["quoteCartRepositoryV1"],"description":"Save quote","operationId":"quoteCartRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["quote"],"properties":{"quote":{"$ref":"#/definitions/quote-data-cart-interface"}},"type":"object"}}],"responses":{"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["quoteCartManagementV1"],"description":"Returns information for the cart for a specified customer.","operationId":"quoteCartManagementV1GetCartForCustomerGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a guest.","operationId":"quoteCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/customers/{customerId}/carts":{"post":{"tags":["quoteCartManagementV1"],"description":"Creates an empty cart and quote for a specified customer.","operationId":"quoteCartManagementV1CreateEmptyCartForCustomerPost","parameters":[{"name":"customerId","in":"path","type":"integer","required":true,"description":"The customer ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Cart ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/order":{"put":{"tags":["quoteCartManagementV1"],"description":"Places an order for a specified cart.","operationId":"quoteCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}":{"get":{"tags":["quoteGuestCartRepositoryV1"],"description":"Enable a guest user to return information for a specified cart.","operationId":"quoteGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestCartManagementV1"],"description":"Assign a specified customer to a specified shopping cart.","operationId":"quoteGuestCartManagementV1AssignCustomerPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["customerId","storeId"],"properties":{"customerId":{"type":"integer","description":"The customer ID."},"storeId":{"type":"integer"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts":{"post":{"tags":["quoteGuestCartManagementV1"],"description":"Enable an customer or guest user to create an empty cart and quote for an anonymous customer.","operationId":"quoteGuestCartManagementV1CreateEmptyCartPost","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Cart ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/order":{"put":{"tags":["quoteGuestCartManagementV1"],"description":"Place an order for a specified cart.","operationId":"quoteGuestCartManagementV1PlaceOrderPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-methods":{"get":{"tags":["quoteShippingMethodManagementV1"],"description":"Lists applicable shipping methods for a specified quote.","operationId":"quoteShippingMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods-by-address-id":{"post":{"tags":["quoteShippingMethodManagementV1"],"description":"Estimate shipping","operationId":"quoteShippingMethodManagementV1EstimateByAddressIdPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressId"],"properties":{"addressId":{"type":"integer","description":"The estimate address id"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/estimate-shipping-methods":{"post":{"tags":["quoteShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-methods":{"get":{"tags":["quoteGuestShippingMethodManagementV1"],"description":"List applicable shipping methods for a specified quote.","operationId":"quoteGuestShippingMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods.","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/estimate-shipping-methods":{"post":{"tags":["quoteGuestShipmentEstimationV1"],"description":"Estimate shipping by address and return list of available shipping methods","operationId":"quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"An array of shipping methods","items":{"$ref":"#/definitions/quote-data-shipping-method-interface"}}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{quoteId}/items":{"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"quoteId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items":{"get":{"tags":["quoteCartItemRepositoryV1"],"description":"Lists items that are assigned to a specified cart.","operationId":"quoteCartItemRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/items/{itemId}":{"put":{"tags":["quoteCartItemRepositoryV1"],"description":"Add/update the specified cart item.","operationId":"quoteCartItemRepositoryV1SavePut","parameters":[{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCartItemRepositoryV1"],"description":"Removes the specified item from the specified cart.","operationId":"quoteCartItemRepositoryV1DeleteByIdDelete","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID of the item to be removed."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items":{"get":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"List items that are assigned to a specified cart.","operationId":"quoteGuestCartItemRepositoryV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of items.","items":{"$ref":"#/definitions/quote-data-cart-item-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/items/{itemId}":{"put":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Add the specified item to the specified cart.","operationId":"quoteGuestCartItemRepositoryV1SavePut","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["cartItem"],"properties":{"cartItem":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-cart-item-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCartItemRepositoryV1"],"description":"Remove the specified item from the specified cart.","operationId":"quoteGuestCartItemRepositoryV1DeleteByIdDelete","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/selected-payment-method":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Returns the payment method for a specified shopping cart.","operationId":"quotePaymentMethodManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quotePaymentMethodManagementV1"],"description":"Adds a specified payment method to a specified shopping cart.","operationId":"quotePaymentMethodManagementV1SetPut","parameters":[{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"redirect url or error message."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-methods":{"get":{"tags":["quotePaymentMethodManagementV1"],"description":"Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quotePaymentMethodManagementV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/selected-payment-method":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Return the payment method for a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-payment-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"Add a specified payment method to a specified shopping cart.","operationId":"quoteGuestPaymentMethodManagementV1SetPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["method"],"properties":{"method":{"$ref":"#/definitions/quote-data-payment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Payment method ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-methods":{"get":{"tags":["quoteGuestPaymentMethodManagementV1"],"description":"List available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"quoteGuestPaymentMethodManagementV1GetListGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","description":"Array of payment methods.","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/billing-address":{"get":{"tags":["quoteBillingAddressManagementV1"],"description":"Returns the billing address for a specified quote.","operationId":"quoteBillingAddressManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteBillingAddressManagementV1"],"description":"Assigns a specified billing address to a specified cart.","operationId":"quoteBillingAddressManagementV1AssignPost","parameters":[{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"},"useForShipping":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/billing-address":{"get":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Return the billing address for a specified quote.","operationId":"quoteGuestBillingAddressManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-address-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["quoteGuestBillingAddressManagementV1"],"description":"Assign a specified billing address to a specified cart.","operationId":"quoteGuestBillingAddressManagementV1AssignPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["address"],"properties":{"address":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Address ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons":{"get":{"tags":["quoteCouponManagementV1"],"description":"Returns information for a coupon in a specified cart.","operationId":"quoteCouponManagementV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteCouponManagementV1"],"description":"Deletes a coupon from a specified cart.","operationId":"quoteCouponManagementV1RemoveDelete","responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/coupons/{couponCode}":{"put":{"tags":["quoteCouponManagementV1"],"description":"Adds a coupon by code to a specified cart.","operationId":"quoteCouponManagementV1SetPut","parameters":[{"name":"couponCode","in":"path","type":"string","required":true,"description":"The coupon code data."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons":{"get":{"tags":["quoteGuestCouponManagementV1"],"description":"Return information for a coupon in a specified cart.","operationId":"quoteGuestCouponManagementV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"The coupon code data."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["quoteGuestCouponManagementV1"],"description":"Delete a coupon from a specified cart.","operationId":"quoteGuestCouponManagementV1RemoveDelete","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/coupons/{couponCode}":{"put":{"tags":["quoteGuestCouponManagementV1"],"description":"Add a coupon by code to a specified cart.","operationId":"quoteGuestCouponManagementV1SetPut","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":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals":{"get":{"tags":["quoteCartTotalRepositoryV1"],"description":"Returns quote totals data for a specified cart.","operationId":"quoteCartTotalRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/collect-totals":{"put":{"tags":["quoteGuestCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals for guest.","operationId":"quoteGuestCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals":{"get":{"tags":["quoteGuestCartTotalRepositoryV1"],"description":"Return quote totals data for a specified cart.","operationId":"quoteGuestCartTotalRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/collect-totals":{"put":{"tags":["quoteCartTotalManagementV1"],"description":"Set shipping/billing methods and additional data for cart and collect totals.","operationId":"quoteCartTotalManagementV1CollectTotalsPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/licence":{"get":{"tags":["checkoutAgreementsCheckoutAgreementsRepositoryV1"],"description":"Lists active checkout agreements.","operationId":"checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet","responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/checkout-agreements-data-agreement-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links":{"get":{"tags":["downloadableLinkRepositoryV1"],"description":"List of links with associated samples","operationId":"downloadableLinkRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/{id}":{"put":{"tags":["downloadableLinkRepositoryV1"],"description":"Update downloadable link of the given product (link type and its resources cannot be changed)","operationId":"downloadableLinkRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["link"],"properties":{"link":{"$ref":"#/definitions/downloadable-data-link-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/{id}":{"delete":{"tags":["downloadableLinkRepositoryV1"],"description":"Delete downloadable link","operationId":"downloadableLinkRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples":{"get":{"tags":["downloadableSampleRepositoryV1"],"description":"List of samples for downloadable product","operationId":"downloadableSampleRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{sku}/downloadable-links/samples/{id}":{"put":{"tags":["downloadableSampleRepositoryV1"],"description":"Update downloadable sample of the given product","operationId":"downloadableSampleRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["sample"],"properties":{"sample":{"$ref":"#/definitions/downloadable-data-sample-interface"},"isGlobalScopeContent":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/downloadable-links/samples/{id}":{"delete":{"tags":["downloadableSampleRepositoryV1"],"description":"Delete downloadable sample","operationId":"downloadableSampleRepositoryV1DeleteDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockItemBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/products/{productSku}/stockItems/{itemId}":{"put":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1UpdateStockItemBySkuPut","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"itemId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["stockItem"],"properties":{"stockItem":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockItems/lowStock/":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"Retrieves a list of SKU's with low inventory qty","operationId":"catalogInventoryStockRegistryV1GetLowStockItemsGet","parameters":[{"name":"scopeId","in":"query","type":"integer","required":true},{"name":"qty","in":"query","type":"number","required":true},{"name":"currentPage","in":"query","type":"integer","required":false},{"name":"pageSize","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-collection-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/stockStatuses/{productSku}":{"get":{"tags":["catalogInventoryStockRegistryV1"],"description":"","operationId":"catalogInventoryStockRegistryV1GetStockStatusBySkuGet","parameters":[{"name":"productSku","in":"path","type":"string","required":true},{"name":"scopeId","in":"query","type":"integer","required":false}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Loads a specified order.","operationId":"salesOrderRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders":{"get":{"tags":["salesOrderRepositoryV1"],"description":"Lists orders that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/create":{"put":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/":{"post":{"tags":["salesOrderRepositoryV1"],"description":"Performs persist operations for a specified order.","operationId":"salesOrderRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/statuses":{"get":{"tags":["salesOrderManagementV1"],"description":"Gets the status for a specified order.","operationId":"salesOrderManagementV1GetStatusGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Order status."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/cancel":{"post":{"tags":["salesOrderManagementV1"],"description":"Cancels a specified order.","operationId":"salesOrderManagementV1CancelPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/emails":{"post":{"tags":["salesOrderManagementV1"],"description":"Emails a user a specified order.","operationId":"salesOrderManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/hold":{"post":{"tags":["salesOrderManagementV1"],"description":"Holds a specified order.","operationId":"salesOrderManagementV1HoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/unhold":{"post":{"tags":["salesOrderManagementV1"],"description":"Releases a specified order from hold status.","operationId":"salesOrderManagementV1UnHoldPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{id}/comments":{"post":{"tags":["salesOrderManagementV1"],"description":"Adds a comment to a specified order.","operationId":"salesOrderManagementV1AddCommentPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."},{"name":"$body","in":"body","schema":{"required":["statusHistory"],"properties":{"statusHistory":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesOrderManagementV1"],"description":"Lists comments for a specified order.","operationId":"salesOrderManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-status-history-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/{parent_id}":{"put":{"tags":["salesOrderAddressRepositoryV1"],"description":"Performs persist operations for a specified order address.","operationId":"salesOrderAddressRepositoryV1SavePut","parameters":[{"name":"parent_id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-order-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-address-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items/{id}":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Loads a specified order item.","operationId":"salesOrderItemRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The order item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/orders/items":{"get":{"tags":["salesOrderItemRepositoryV1"],"description":"Lists order items that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesOrderItemRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-order-item-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Loads a specified invoice.","operationId":"salesInvoiceRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices":{"get":{"tags":["salesInvoiceRepositoryV1"],"description":"Lists invoices that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesInvoiceRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/":{"post":{"tags":["salesInvoiceRepositoryV1"],"description":"Performs persist operations for a specified invoice.","operationId":"salesInvoiceRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/comments":{"get":{"tags":["salesInvoiceManagementV1"],"description":"Lists comments for a specified invoice.","operationId":"salesInvoiceManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/emails":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Emails a user a specified invoice.","operationId":"salesInvoiceManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/void":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Voids a specified invoice.","operationId":"salesInvoiceManagementV1SetVoidPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The invoice ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/{id}/capture":{"post":{"tags":["salesInvoiceManagementV1"],"description":"Sets invoice capture.","operationId":"salesInvoiceManagementV1SetCapturePost","parameters":[{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/invoices/comments":{"post":{"tags":["salesInvoiceCommentRepositoryV1"],"description":"Performs persist operations for a specified invoice comment.","operationId":"salesInvoiceCommentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/comments":{"get":{"tags":["salesCreditmemoManagementV1"],"description":"Lists comments for a specified credit memo.","operationId":"salesCreditmemoManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesCreditmemoCommentRepositoryV1"],"description":"Performs persist operations for a specified entity.","operationId":"salesCreditmemoCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}":{"put":{"tags":["salesCreditmemoManagementV1"],"description":"Cancels a specified credit memo.","operationId":"salesCreditmemoManagementV1CancelPut","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Loads a specified credit memo.","operationId":"salesCreditmemoRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/{id}/emails":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Emails a user a specified credit memo.","operationId":"salesCreditmemoManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The credit memo ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo/refund":{"post":{"tags":["salesCreditmemoManagementV1"],"description":"Prepare creditmemo to refund and save it.","operationId":"salesCreditmemoManagementV1RefundPost","parameters":[{"name":"$body","in":"body","schema":{"required":["creditmemo"],"properties":{"creditmemo":{"$ref":"#/definitions/sales-data-creditmemo-interface"},"offlineRequested":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemos":{"get":{"tags":["salesCreditmemoRepositoryV1"],"description":"Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesCreditmemoRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/creditmemo":{"post":{"tags":["salesCreditmemoRepositoryV1"],"description":"Performs persist operations for a specified credit memo.","operationId":"salesCreditmemoRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Loads a specified shipment.","operationId":"salesShipmentRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipments":{"get":{"tags":["salesShipmentRepositoryV1"],"description":"Lists shipments that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#ShipmentRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesShipmentRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/":{"post":{"tags":["salesShipmentRepositoryV1"],"description":"Performs persist operations for a specified shipment.","operationId":"salesShipmentRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/comments":{"get":{"tags":["salesShipmentManagementV1"],"description":"Lists comments for a specified shipment.","operationId":"salesShipmentManagementV1GetCommentsListGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["salesShipmentCommentRepositoryV1"],"description":"Performs persist operations for a specified shipment comment.","operationId":"salesShipmentCommentRepositoryV1SavePost","parameters":[{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/emails":{"post":{"tags":["salesShipmentManagementV1"],"description":"Emails user a specified shipment.","operationId":"salesShipmentManagementV1NotifyPost","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/{id}/label":{"get":{"tags":["salesShipmentManagementV1"],"description":"Gets a specified shipment label.","operationId":"salesShipmentManagementV1GetLabelGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment label ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Shipment label."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track":{"post":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Performs persist operations for a specified shipment track.","operationId":"salesShipmentTrackRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["entity"],"properties":{"entity":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-shipment-track-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/shipment/track/{id}":{"delete":{"tags":["salesShipmentTrackRepositoryV1"],"description":"Deletes a specified shipment track by ID.","operationId":"salesShipmentTrackRepositoryV1DeleteByIdDelete","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The shipment track ID."}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions/{id}":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Loads a specified transaction.","operationId":"salesTransactionRepositoryV1GetGet","parameters":[{"name":"id","in":"path","type":"integer","required":true,"description":"The transaction ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/transactions":{"get":{"tags":["salesTransactionRepositoryV1"],"description":"Lists transactions that match specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TransactionRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesTransactionRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-data-transaction-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message":{"get":{"tags":["giftMessageCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageCartRepositoryV1GetGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageCartRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"integer","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/gift-message/{itemId}":{"get":{"tags":["giftMessageItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1GetGet","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageItemRepositoryV1SavePost","parameters":[{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message":{"get":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Return the gift message for a specified order.","operationId":"giftMessageGuestCartRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestCartRepositoryV1"],"description":"Set the gift message for an entire order.","operationId":"giftMessageGuestCartRepositoryV1SavePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The cart ID."},{"name":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/gift-message/{itemId}":{"get":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Return the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1GetGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true,"description":"The shopping cart ID."},{"name":"itemId","in":"path","type":"integer","required":true,"description":"The item ID."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/gift-message-data-message-interface"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"post":{"tags":["giftMessageGuestItemRepositoryV1"],"description":"Set the gift message for a specified item in a specified shopping cart.","operationId":"giftMessageGuestItemRepositoryV1SavePost","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":"$body","in":"body","schema":{"required":["giftMessage"],"properties":{"giftMessage":{"$ref":"#/definitions/gift-message-data-message-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/shipping-information":{"post":{"tags":["checkoutGuestShippingInformationManagementV1"],"description":"","operationId":"checkoutGuestShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/shipping-information":{"post":{"tags":["checkoutShippingInformationManagementV1"],"description":"","operationId":"checkoutShippingInformationManagementV1SaveAddressInformationPost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-shipping-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/{cartId}/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"integer","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/totals-information":{"post":{"tags":["checkoutTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutTotalsInformationManagementV1CalculatePost","parameters":[{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/totals-information":{"post":{"tags":["checkoutGuestTotalsInformationManagementV1"],"description":"Calculate quote totals based on address and shipping method.","operationId":"checkoutGuestTotalsInformationManagementV1CalculatePost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["addressInformation"],"properties":{"addressInformation":{"$ref":"#/definitions/checkout-data-totals-information-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/quote-data-totals-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet","parameters":[{"name":"cartId","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/guest-carts/{cartId}/set-payment-information":{"post":{"tags":["checkoutGuestPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"cartId","in":"path","type":"string","required":true},{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information and place order for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Get payment information","operationId":"checkoutPaymentInformationManagementV1GetPaymentInformationGet","responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/checkout-data-payment-details-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/carts/mine/set-payment-information":{"post":{"tags":["checkoutPaymentInformationManagementV1"],"description":"Set payment information for a specified cart.","operationId":"checkoutPaymentInformationManagementV1SavePaymentInformationPost","parameters":[{"name":"$body","in":"body","schema":{"required":["paymentMethod"],"properties":{"paymentMethod":{"$ref":"#/definitions/quote-data-payment-interface"},"billingAddress":{"$ref":"#/definitions/quote-data-address-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer","description":"Order ID."}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates":{"post":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRateRepositoryV1"],"description":"Create or update tax rate","operationId":"taxTaxRateRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["taxRate"],"properties":{"taxRate":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/{rateId}":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Get tax rate","operationId":"taxTaxRateRepositoryV1GetGet","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxRateRepositoryV1"],"description":"Delete tax rate","operationId":"taxTaxRateRepositoryV1DeleteByIdDelete","parameters":[{"name":"rateId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRates/search":{"get":{"tags":["taxTaxRateRepositoryV1"],"description":"Search TaxRates This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRateRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRateRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rate-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules":{"post":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["taxTaxRuleRepositoryV1"],"description":"Save TaxRule","operationId":"taxTaxRuleRepositoryV1SavePut","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/{ruleId}":{"delete":{"tags":["taxTaxRuleRepositoryV1"],"description":"Delete TaxRule","operationId":"taxTaxRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Get TaxRule","operationId":"taxTaxRuleRepositoryV1GetGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxRules/search":{"get":{"tags":["taxTaxRuleRepositoryV1"],"description":"Search TaxRules This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxRuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-rule-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses":{"post":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{taxClassId}":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Get a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1GetGet","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["taxTaxClassRepositoryV1"],"description":"Delete a tax class with the given tax class id.","operationId":"taxTaxClassRepositoryV1DeleteByIdDelete","parameters":[{"name":"taxClassId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"True if the tax class was deleted, false otherwise"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/{classId}":{"put":{"tags":["taxTaxClassRepositoryV1"],"description":"Create a Tax Class","operationId":"taxTaxClassRepositoryV1SavePut","parameters":[{"name":"classId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["taxClass"],"properties":{"taxClass":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"id for the newly created Tax class"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/taxClasses/search":{"get":{"tags":["taxTaxClassRepositoryV1"],"description":"Retrieve tax classes which match a specific criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#TaxClassRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"taxTaxClassRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/tax-data-tax-class-search-results-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children":{"get":{"tags":["configurableProductLinkManagementV1"],"description":"Get all children for Configurable product","operationId":"configurableProductLinkManagementV1GetChildrenGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/children/{childSku}":{"delete":{"tags":["configurableProductLinkManagementV1"],"description":"Remove configurable product option","operationId":"configurableProductLinkManagementV1RemoveChildDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"childSku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/child":{"post":{"tags":["configurableProductLinkManagementV1"],"description":"","operationId":"configurableProductLinkManagementV1AddChildPost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["childSku"],"properties":{"childSku":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/variation":{"put":{"tags":["configurableProductConfigurableProductManagementV1"],"description":"Generate variation based on same product","operationId":"configurableProductConfigurableProductManagementV1GenerateVariationPut","parameters":[{"name":"$body","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"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/catalog-data-product-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/{id}":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get option for configurable product","operationId":"configurableProductOptionRepositoryV1GetGet","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePut","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["configurableProductOptionRepositoryV1"],"description":"Remove option from configurable product","operationId":"configurableProductOptionRepositoryV1DeleteByIdDelete","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"id","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options/all":{"get":{"tags":["configurableProductOptionRepositoryV1"],"description":"Get all options for configurable product","operationId":"configurableProductOptionRepositoryV1GetListGet","parameters":[{"name":"sku","in":"path","type":"string","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/configurable-products/{sku}/options":{"post":{"tags":["configurableProductOptionRepositoryV1"],"description":"Save option","operationId":"configurableProductOptionRepositoryV1SavePost","parameters":[{"name":"sku","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["option"],"properties":{"option":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"integer"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/{ruleId}":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Get rule by ID.","operationId":"salesRuleRuleRepositoryV1GetByIdGet","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePut","parameters":[{"name":"ruleId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleRuleRepositoryV1"],"description":"Delete rule by ID.","operationId":"salesRuleRuleRepositoryV1DeleteByIdDelete","parameters":[{"name":"ruleId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules/search":{"get":{"tags":["salesRuleRuleRepositoryV1"],"description":"Retrieve sales rules that match te specified criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleRuleRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/salesRules":{"post":{"tags":["salesRuleRuleRepositoryV1"],"description":"Save sales rule.","operationId":"salesRuleRuleRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["rule"],"properties":{"rule":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/{couponId}":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Get coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1GetByIdGet","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"put":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePut","parameters":[{"name":"couponId","in":"path","type":"string","required":true},{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}},"delete":{"tags":["salesRuleCouponRepositoryV1"],"description":"Delete coupon by coupon id.","operationId":"salesRuleCouponRepositoryV1DeleteByIdDelete","parameters":[{"name":"couponId","in":"path","type":"integer","required":true}],"responses":{"200":{"description":"200 Success.","schema":{"type":"boolean","description":"true on success"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/search":{"get":{"tags":["salesRuleCouponRepositoryV1"],"description":"Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object\u2019s attributes might not be included. See https://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.","operationId":"salesRuleCouponRepositoryV1GetListGet","parameters":[{"name":"searchCriteria[filterGroups][][filters][][field]","in":"query","type":"string","description":"Field"},{"name":"searchCriteria[filterGroups][][filters][][value]","in":"query","type":"string","description":"Value"},{"name":"searchCriteria[filterGroups][][filters][][conditionType]","in":"query","type":"string","description":"Condition type"},{"name":"searchCriteria[sortOrders][][field]","in":"query","type":"string","description":"Sorting field."},{"name":"searchCriteria[sortOrders][][direction]","in":"query","type":"string","description":"Sorting direction."},{"name":"searchCriteria[pageSize]","in":"query","type":"integer","description":"Page size."},{"name":"searchCriteria[currentPage]","in":"query","type":"integer","description":"Current page."}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-search-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons":{"post":{"tags":["salesRuleCouponRepositoryV1"],"description":"Save a coupon.","operationId":"salesRuleCouponRepositoryV1SavePost","parameters":[{"name":"$body","in":"body","schema":{"required":["coupon"],"properties":{"coupon":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/generate":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Generate coupon for a rule","operationId":"salesRuleCouponManagementV1GeneratePost","parameters":[{"name":"$body","in":"body","schema":{"required":["couponSpec"],"properties":{"couponSpec":{"$ref":"#/definitions/sales-rule-data-coupon-generation-spec-interface"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"array","items":{"type":"string"}}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByIds":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon ids.","operationId":"salesRuleCouponManagementV1DeleteByIdsPost","parameters":[{"name":"$body","in":"body","schema":{"required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/coupons/deleteByCodes":{"post":{"tags":["salesRuleCouponManagementV1"],"description":"Delete coupon by coupon codes.","operationId":"salesRuleCouponManagementV1DeleteByCodesPost","parameters":[{"name":"$body","in":"body","schema":{"required":["codes"],"properties":{"codes":{"type":"array","items":{"type":"string"}},"ignoreInvalidCoupons":{"type":"boolean"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"$ref":"#/definitions/sales-rule-data-coupon-mass-delete-result-interface"}},"401":{"description":"401 Unauthorized","schema":{"$ref":"#/definitions/error-response"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/admin/token":{"post":{"tags":["integrationAdminTokenServiceV1"],"description":"Create access token for admin given the admin credentials.","operationId":"integrationAdminTokenServiceV1CreateAdminAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"500":{"description":"Internal Server error","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}},"/V1/integration/customer/token":{"post":{"tags":["integrationCustomerTokenServiceV1"],"description":"Create access token for admin given the customer credentials.","operationId":"integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost","parameters":[{"name":"$body","in":"body","schema":{"required":["username","password"],"properties":{"username":{"type":"string"},"password":{"type":"string"}},"type":"object"}}],"responses":{"200":{"description":"200 Success.","schema":{"type":"string","description":"Token created"}},"400":{"description":"400 Bad Request","schema":{"$ref":"#/definitions/error-response"}},"default":{"description":"Unexpected error","schema":{"$ref":"#/definitions/error-response"}}}}}},"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"}}},"store-data-store-interface":{"type":"object","description":"Store interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Store name"},"website_id":{"type":"integer"},"store_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-store-extension-interface"}},"required":["id","code","name","website_id","store_group_id"]},"store-data-store-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreInterface"},"store-data-group-interface":{"type":"object","description":"Group interface","properties":{"id":{"type":"integer"},"website_id":{"type":"integer"},"root_category_id":{"type":"integer"},"default_store_id":{"type":"integer"},"name":{"type":"string"},"extension_attributes":{"$ref":"#/definitions/store-data-group-extension-interface"}},"required":["id","website_id","root_category_id","default_store_id","name"]},"store-data-group-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\GroupInterface"},"store-data-website-interface":{"type":"object","description":"Website interface","properties":{"id":{"type":"integer"},"code":{"type":"string"},"name":{"type":"string","description":"Website name"},"default_group_id":{"type":"integer"},"extension_attributes":{"$ref":"#/definitions/store-data-website-extension-interface"}},"required":["id","code","name","default_group_id"]},"store-data-website-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\WebsiteInterface"},"store-data-store-config-interface":{"type":"object","description":"StoreConfig interface","properties":{"id":{"type":"integer","description":"Store id"},"code":{"type":"string","description":"Store code"},"website_id":{"type":"integer","description":"Website id of the store"},"locale":{"type":"string","description":"Store locale"},"base_currency_code":{"type":"string","description":"Base currency code"},"default_display_currency_code":{"type":"string","description":"Default display currency code"},"timezone":{"type":"string","description":"Timezone of the store"},"weight_unit":{"type":"string","description":"The unit of weight"},"base_url":{"type":"string","description":"Base URL for the store"},"base_link_url":{"type":"string","description":"Base link URL for the store"},"base_static_url":{"type":"string","description":"Base static URL for the store"},"base_media_url":{"type":"string","description":"Base media URL for the store"},"secure_base_url":{"type":"string","description":"Secure base URL for the store"},"secure_base_link_url":{"type":"string","description":"Secure base link URL for the store"},"secure_base_static_url":{"type":"string","description":"Secure base static URL for the store"},"secure_base_media_url":{"type":"string","description":"Secure base media URL for the store"},"extension_attributes":{"$ref":"#/definitions/store-data-store-config-extension-interface"}},"required":["id","code","website_id","locale","base_currency_code","default_display_currency_code","timezone","weight_unit","base_url","base_link_url","base_static_url","base_media_url","secure_base_url","secure_base_link_url","secure_base_static_url","secure_base_media_url"]},"store-data-store-config-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Store\\Api\\Data\\StoreConfigInterface"},"directory-data-currency-information-interface":{"type":"object","description":"Currency Information interface.","properties":{"base_currency_code":{"type":"string","description":"The base currency code for the store."},"base_currency_symbol":{"type":"string","description":"The currency symbol of the base currency for the store."},"default_display_currency_code":{"type":"string","description":"The default display currency code for the store."},"default_display_currency_symbol":{"type":"string","description":"The currency symbol of the default display currency for the store."},"available_currency_codes":{"type":"array","description":"The list of allowed currency codes for the store.","items":{"type":"string"}},"exchange_rates":{"type":"array","description":"The list of exchange rate information for the store.","items":{"$ref":"#/definitions/directory-data-exchange-rate-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-currency-information-extension-interface"}},"required":["base_currency_code","base_currency_symbol","default_display_currency_code","default_display_currency_symbol","available_currency_codes","exchange_rates"]},"directory-data-exchange-rate-interface":{"type":"object","description":"Exchange Rate interface.","properties":{"currency_to":{"type":"string","description":"The currency code associated with the exchange rate."},"rate":{"type":"number","description":"The exchange rate for the associated currency and the store's base currency."},"extension_attributes":{"$ref":"#/definitions/directory-data-exchange-rate-extension-interface"}},"required":["currency_to","rate"]},"directory-data-exchange-rate-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\ExchangeRateInterface"},"directory-data-currency-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CurrencyInformationInterface"},"directory-data-country-information-interface":{"type":"object","description":"Country Information interface.","properties":{"id":{"type":"string","description":"The country id for the store."},"two_letter_abbreviation":{"type":"string","description":"The country 2 letter abbreviation for the store."},"three_letter_abbreviation":{"type":"string","description":"The country 3 letter abbreviation for the store."},"full_name_locale":{"type":"string","description":"The country full name (in store locale) for the store."},"full_name_english":{"type":"string","description":"The country full name (in English) for the store."},"available_regions":{"type":"array","description":"The available regions for the store.","items":{"$ref":"#/definitions/directory-data-region-information-interface"}},"extension_attributes":{"$ref":"#/definitions/directory-data-country-information-extension-interface"}},"required":["id","two_letter_abbreviation","three_letter_abbreviation","full_name_locale","full_name_english"]},"directory-data-region-information-interface":{"type":"object","description":"Region Information interface.","properties":{"id":{"type":"string","description":"Region id"},"code":{"type":"string","description":"Region code"},"name":{"type":"string","description":"Region name"},"extension_attributes":{"$ref":"#/definitions/directory-data-region-information-extension-interface"}},"required":["id","code","name"]},"directory-data-region-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\RegionInformationInterface"},"directory-data-country-information-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Directory\\Api\\Data\\CountryInformationInterface"},"eav-data-attribute-set-search-results-interface":{"type":"object","description":"Interface AttributeSetSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-set-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"framework-search-criteria-interface":{"type":"object","description":"Search criteria interface.","properties":{"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["filter_groups"]},"framework-search-filter-group":{"type":"object","description":"Groups two or more filters together using a logical OR","properties":{"filters":{"type":"array","description":"A list of filters in this group","items":{"$ref":"#/definitions/framework-filter"}}}},"framework-filter":{"type":"object","description":"Filter which can be used by any methods from service layer.","properties":{"field":{"type":"string","description":"Field"},"value":{"type":"string","description":"Value"},"condition_type":{"type":"string","description":"Condition type"}},"required":["field","value"]},"framework-sort-order":{"type":"object","description":"Data object for sort order.","properties":{"field":{"type":"string","description":"Sorting field."},"direction":{"type":"string","description":"Sorting direction."}},"required":["field","direction"]},"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-group-search-results-interface":{"type":"object","description":"Interface for customer groups search results.","properties":{"items":{"type":"array","description":"Customer groups list.","items":{"$ref":"#/definitions/customer-data-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-attribute-metadata-interface":{"type":"object","description":"Customer attribute metadata interface.","properties":{"frontend_input":{"type":"string","description":"HTML for input element."},"input_filter":{"type":"string","description":"Template used for input (e.g. \"date\")"},"store_label":{"type":"string","description":"Label of the store."},"validation_rules":{"type":"array","description":"Validation rules.","items":{"$ref":"#/definitions/customer-data-validation-rule-interface"}},"multiline_count":{"type":"integer","description":"Of lines of the attribute value."},"visible":{"type":"boolean","description":"Attribute is visible on frontend."},"required":{"type":"boolean","description":"Attribute is required."},"data_model":{"type":"string","description":"Data model for attribute."},"options":{"type":"array","description":"Options of the attribute (key => value pairs for select)","items":{"$ref":"#/definitions/customer-data-option-interface"}},"frontend_class":{"type":"string","description":"Class which is used to display the attribute on frontend."},"user_defined":{"type":"boolean","description":"Current attribute has been defined by a user."},"sort_order":{"type":"integer","description":"Attributes sort order."},"frontend_label":{"type":"string","description":"Label which supposed to be displayed on frontend."},"note":{"type":"string","description":"The note attribute for the element."},"system":{"type":"boolean","description":"This is a system attribute."},"backend_type":{"type":"string","description":"Backend type."},"is_used_in_grid":{"type":"boolean","description":"It is used in customer grid"},"is_visible_in_grid":{"type":"boolean","description":"It is visible in customer grid"},"is_filterable_in_grid":{"type":"boolean","description":"It is filterable in customer grid"},"is_searchable_in_grid":{"type":"boolean","description":"It is searchable in customer grid"},"attribute_code":{"type":"string","description":"Code of the attribute."}},"required":["frontend_input","input_filter","store_label","validation_rules","multiline_count","visible","required","data_model","options","frontend_class","user_defined","sort_order","frontend_label","note","system","backend_type","attribute_code"]},"customer-data-validation-rule-interface":{"type":"object","description":"Validation rule interface.","properties":{"name":{"type":"string","description":"Validation rule name"},"value":{"type":"string","description":"Validation rule value"}},"required":["name","value"]},"customer-data-option-interface":{"type":"object","description":"Option interface.","properties":{"label":{"type":"string","description":"Option label"},"value":{"type":"string","description":"Option value"},"options":{"type":"array","description":"Nested options","items":{"$ref":"#/definitions/customer-data-option-interface"}}},"required":["label"]},"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":{"is_subscribed":{"type":"boolean"}}},"customer-data-customer-search-results-interface":{"type":"object","description":"Interface for customer search results.","properties":{"items":{"type":"array","description":"Customers list.","items":{"$ref":"#/definitions/customer-data-customer-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"customer-data-validation-results-interface":{"type":"object","description":"Validation results interface.","properties":{"valid":{"type":"boolean","description":"If the provided data is valid."},"messages":{"type":"array","description":"Error messages as array in case of validation failure, else return empty array.","items":{"type":"string"}}},"required":["valid","messages"]},"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-page-search-results-interface":{"type":"object","description":"Interface for cms page search results.","properties":{"items":{"type":"array","description":"Pages list.","items":{"$ref":"#/definitions/cms-data-page-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"]},"cms-data-block-search-results-interface":{"type":"object","description":"Interface for cms block search results.","properties":{"items":{"type":"array","description":"Blocks list.","items":{"$ref":"#/definitions/cms-data-block-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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":{"bundle_product_options":{"type":"array","items":{"$ref":"#/definitions/bundle-data-option-interface"}},"downloadable_product_links":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-link-interface"}},"downloadable_product_samples":{"type":"array","items":{"$ref":"#/definitions/downloadable-data-sample-interface"}},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"configurable_product_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-option-interface"}},"configurable_product_links":{"type":"array","items":{"type":"integer"}}}},"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"},"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"},"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"},"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"},"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"},"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"},"catalog-data-product-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-attribute-type-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Value"},"label":{"type":"string","description":"Type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-attribute-type-extension-interface"}},"required":["value","label"]},"catalog-data-product-attribute-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductAttributeTypeInterface"},"catalog-data-product-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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","is_required","frontend_labels"]},"catalog-data-eav-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\EavAttributeInterface"},"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"]},"catalog-data-product-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-product-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-category-attribute-interface":{"type":"object","description":"","properties":{"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"},"extension_attributes":{"$ref":"#/definitions/catalog-data-eav-attribute-extension-interface"},"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","is_required","frontend_labels"]},"catalog-data-category-attribute-search-results-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Attributes list.","items":{"$ref":"#/definitions/catalog-data-category-attribute-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-data-product-type-interface":{"type":"object","description":"Product type details","properties":{"name":{"type":"string","description":"Product type code"},"label":{"type":"string","description":"Product type label"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-type-extension-interface"}},"required":["name","label"]},"catalog-data-product-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductTypeInterface"},"eav-data-attribute-group-search-results-interface":{"type":"object","description":"Interface AttributeGroupSearchResultsInterface","properties":{"items":{"type":"array","description":"Attribute sets list.","items":{"$ref":"#/definitions/eav-data-attribute-group-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-category-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"path":{"type":"string"},"available_sort_by":{"type":"array","items":{"type":"string"}},"include_in_menu":{"type":"boolean"},"extension_attributes":{"$ref":"#/definitions/catalog-data-category-extension-interface"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["name"]},"catalog-data-category-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\CategoryInterface"},"catalog-data-category-tree-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"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"},"product_count":{"type":"integer","description":"Product count"},"children_data":{"type":"array","items":{"$ref":"#/definitions/catalog-data-category-tree-interface"}}},"required":["parent_id","name","is_active","position","level","product_count","children_data"]},"catalog-data-product-custom-option-type-interface":{"type":"object","description":"","properties":{"label":{"type":"string","description":"Option type label"},"code":{"type":"string","description":"Option type code"},"group":{"type":"string","description":"Option type group"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-custom-option-type-extension-interface"}},"required":["label","code","group"]},"catalog-data-product-custom-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductCustomOptionTypeInterface"},"catalog-data-product-link-type-interface":{"type":"object","description":"","properties":{"code":{"type":"integer","description":"Link type code"},"name":{"type":"string","description":"Link type name"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-type-extension-interface"}},"required":["code","name"]},"catalog-data-product-link-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkTypeInterface"},"catalog-data-product-link-attribute-interface":{"type":"object","description":"","properties":{"code":{"type":"string","description":"Attribute code"},"type":{"type":"string","description":"Attribute type"},"extension_attributes":{"$ref":"#/definitions/catalog-data-product-link-attribute-extension-interface"}},"required":["code","type"]},"catalog-data-product-link-attribute-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Catalog\\Api\\Data\\ProductLinkAttributeInterface"},"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"]},"framework-search-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/framework-search-document-interface"}},"aggregations":{"$ref":"#/definitions/framework-search-aggregation-interface"},"search_criteria":{"$ref":"#/definitions/framework-search-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","aggregations","search_criteria","total_count"]},"framework-search-document-interface":{"type":"object","description":"","properties":{"id":{"type":"integer"},"custom_attributes":{"type":"array","description":"Custom attributes values.","items":{"$ref":"#/definitions/framework-attribute-interface"}}},"required":["id"]},"framework-search-aggregation-interface":{"type":"object","description":"Faceted data","properties":{"buckets":{"type":"array","description":"All Document fields","items":{"$ref":"#/definitions/framework-search-bucket-interface"}},"bucket_names":{"type":"array","description":"Document field names","items":{"type":"string"}}},"required":["buckets","bucket_names"]},"framework-search-bucket-interface":{"type":"object","description":"Facet Bucket","properties":{"name":{"type":"string","description":"Field name"},"values":{"type":"array","description":"Field values","items":{"$ref":"#/definitions/framework-search-aggregation-value-interface"}}},"required":["name","values"]},"framework-search-aggregation-value-interface":{"type":"object","description":"","properties":{"value":{"type":"string","description":"Aggregation"},"metrics":{"type":"array","description":"Metrics","items":{"type":"string"}}},"required":["value","metrics"]},"framework-search-search-criteria-interface":{"type":"object","description":"","properties":{"request_name":{"type":"string"},"filter_groups":{"type":"array","description":"A list of filter groups.","items":{"$ref":"#/definitions/framework-search-filter-group"}},"sort_orders":{"type":"array","description":"Sort order.","items":{"$ref":"#/definitions/framework-sort-order"}},"page_size":{"type":"integer","description":"Page size."},"current_page":{"type":"integer","description":"Current page."}},"required":["request_name","filter_groups"]},"bundle-data-option-type-interface":{"type":"object","description":"Interface OptionTypeInterface","properties":{"label":{"type":"string","description":"Type label"},"code":{"type":"string","description":"Type code"},"extension_attributes":{"$ref":"#/definitions/bundle-data-option-type-extension-interface"}},"required":["label","code"]},"bundle-data-option-type-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Bundle\\Api\\Data\\OptionTypeInterface"},"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":"integer","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"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-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"},"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"]},"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"},"quote-data-cart-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\CartItemInterface"},"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"},"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"}}}},"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"},"quote-data-cart-search-results-interface":{"type":"object","description":"Interface CartSearchResultsInterface","properties":{"items":{"type":"array","description":"Carts list.","items":{"$ref":"#/definitions/quote-data-cart-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-shipping-method-interface":{"type":"object","description":"Interface ShippingMethodInterface","properties":{"carrier_code":{"type":"string","description":"Shipping carrier code."},"method_code":{"type":"string","description":"Shipping method code."},"carrier_title":{"type":"string","description":"Shipping carrier title. Otherwise, null."},"method_title":{"type":"string","description":"Shipping method title. Otherwise, null."},"amount":{"type":"number","description":"Shipping amount in store currency."},"base_amount":{"type":"number","description":"Shipping amount in base currency."},"available":{"type":"boolean","description":"The value of the availability flag for the current shipping method."},"extension_attributes":{"$ref":"#/definitions/quote-data-shipping-method-extension-interface"},"error_message":{"type":"string","description":"Shipping Error message."},"price_excl_tax":{"type":"number","description":"Shipping price excl tax."},"price_incl_tax":{"type":"number","description":"Shipping price incl tax."}},"required":["carrier_code","method_code","amount","base_amount","available","error_message","price_excl_tax","price_incl_tax"]},"quote-data-shipping-method-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\ShippingMethodInterface"},"quote-data-payment-method-interface":{"type":"object","description":"Interface PaymentMethodInterface","properties":{"code":{"type":"string","description":"Payment method code"},"title":{"type":"string","description":"Payment method title"}},"required":["code","title"]},"quote-data-totals-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"grand_total":{"type":"number","description":"Grand total in quote currency"},"base_grand_total":{"type":"number","description":"Grand total in base currency"},"subtotal":{"type":"number","description":"Subtotal in quote currency"},"base_subtotal":{"type":"number","description":"Subtotal in base currency"},"discount_amount":{"type":"number","description":"Discount amount in quote currency"},"base_discount_amount":{"type":"number","description":"Discount amount in base currency"},"subtotal_with_discount":{"type":"number","description":"Subtotal in quote currency with applied discount"},"base_subtotal_with_discount":{"type":"number","description":"Subtotal in base currency with applied discount"},"shipping_amount":{"type":"number","description":"Shipping amount in quote currency"},"base_shipping_amount":{"type":"number","description":"Shipping amount in base currency"},"shipping_discount_amount":{"type":"number","description":"Shipping discount amount in quote currency"},"base_shipping_discount_amount":{"type":"number","description":"Shipping discount amount in base currency"},"tax_amount":{"type":"number","description":"Tax amount in quote currency"},"base_tax_amount":{"type":"number","description":"Tax amount in base currency"},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"shipping_tax_amount":{"type":"number","description":"Shipping tax amount in quote currency"},"base_shipping_tax_amount":{"type":"number","description":"Shipping tax amount in base currency"},"subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in quote currency"},"base_subtotal_incl_tax":{"type":"number","description":"Subtotal including tax in base currency"},"shipping_incl_tax":{"type":"number","description":"Shipping including tax in quote currency"},"base_shipping_incl_tax":{"type":"number","description":"Shipping including tax in base currency"},"base_currency_code":{"type":"string","description":"Base currency code"},"quote_currency_code":{"type":"string","description":"Quote currency code"},"coupon_code":{"type":"string","description":"Applied coupon code"},"items_qty":{"type":"integer","description":"Items qty"},"items":{"type":"array","description":"Totals by items","items":{"$ref":"#/definitions/quote-data-totals-item-interface"}},"total_segments":{"type":"array","description":"Dynamically calculated totals","items":{"$ref":"#/definitions/quote-data-total-segment-interface"}},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-extension-interface"}},"required":["weee_tax_applied_amount","total_segments"]},"quote-data-totals-item-interface":{"type":"object","description":"Interface TotalsItemInterface","properties":{"item_id":{"type":"integer","description":"Item id"},"price":{"type":"number","description":"Item price in quote currency."},"base_price":{"type":"number","description":"Item price in base currency."},"qty":{"type":"number","description":"Item quantity."},"row_total":{"type":"number","description":"Row total in quote currency."},"base_row_total":{"type":"number","description":"Row total in base currency."},"row_total_with_discount":{"type":"number","description":"Row total with discount in quote currency. Otherwise, null."},"tax_amount":{"type":"number","description":"Tax amount in quote currency. Otherwise, null."},"base_tax_amount":{"type":"number","description":"Tax amount in base currency. Otherwise, null."},"tax_percent":{"type":"number","description":"Tax percent. Otherwise, null."},"discount_amount":{"type":"number","description":"Discount amount in quote currency. Otherwise, null."},"base_discount_amount":{"type":"number","description":"Discount amount in base currency. Otherwise, null."},"discount_percent":{"type":"number","description":"Discount percent. Otherwise, null."},"price_incl_tax":{"type":"number","description":"Price including tax in quote currency. Otherwise, null."},"base_price_incl_tax":{"type":"number","description":"Price including tax in base currency. Otherwise, null."},"row_total_incl_tax":{"type":"number","description":"Row total including tax in quote currency. Otherwise, null."},"base_row_total_incl_tax":{"type":"number","description":"Row total including tax in base currency. Otherwise, null."},"options":{"type":"string","description":"Item price in quote currency."},"weee_tax_applied_amount":{"type":"number","description":"Item weee tax applied amount in quote currency."},"weee_tax_applied":{"type":"string","description":"Item weee tax applied in quote currency."},"extension_attributes":{"$ref":"#/definitions/quote-data-totals-item-extension-interface"},"name":{"type":"string","description":"Product name. Otherwise, null."}},"required":["item_id","price","base_price","qty","row_total","base_row_total","options","weee_tax_applied_amount","weee_tax_applied"]},"quote-data-totals-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsItemInterface"},"quote-data-total-segment-interface":{"type":"object","description":"Interface TotalsInterface","properties":{"code":{"type":"string","description":"Code"},"title":{"type":"string","description":"Total title"},"value":{"type":"number","description":"Total value"},"area":{"type":"string","description":"Display area code."},"extension_attributes":{"$ref":"#/definitions/quote-data-total-segment-extension-interface"}},"required":["code","value"]},"quote-data-total-segment-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalSegmentInterface","properties":{"tax_grandtotal_details":{"type":"array","items":{"$ref":"#/definitions/tax-data-grand-total-details-interface"}}}},"tax-data-grand-total-details-interface":{"type":"object","description":"Interface GrandTotalDetailsInterface","properties":{"amount":{"type":"number","description":"Tax amount value"},"rates":{"type":"array","description":"Tax rates info","items":{"$ref":"#/definitions/tax-data-grand-total-rates-interface"}},"group_id":{"type":"integer","description":"Group identifier"}},"required":["amount","rates","group_id"]},"tax-data-grand-total-rates-interface":{"type":"object","description":"Interface GrandTotalRatesInterface","properties":{"percent":{"type":"string","description":"Tax percentage value"},"title":{"type":"string","description":"Rate title"}},"required":["percent","title"]},"quote-data-totals-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Quote\\Api\\Data\\TotalsInterface"},"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"}}},"checkout-agreements-data-agreement-interface":{"type":"object","description":"Interface AgreementInterface","properties":{"agreement_id":{"type":"integer","description":"Agreement ID."},"name":{"type":"string","description":"Agreement name."},"content":{"type":"string","description":"Agreement content."},"content_height":{"type":"string","description":"Agreement content height. Otherwise, null."},"checkbox_text":{"type":"string","description":"Agreement checkbox text."},"is_active":{"type":"boolean","description":"Agreement status."},"is_html":{"type":"boolean","description":"* true - HTML. * false - plain text."},"mode":{"type":"integer","description":"The agreement applied mode."},"extension_attributes":{"$ref":"#/definitions/checkout-agreements-data-agreement-extension-interface"}},"required":["agreement_id","name","content","checkbox_text","is_active","is_html","mode"]},"checkout-agreements-data-agreement-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CheckoutAgreements\\Api\\Data\\AgreementInterface"},"catalog-inventory-data-stock-status-collection-interface":{"type":"object","description":"Stock Status collection interface","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/catalog-inventory-data-stock-status-interface"}},"search_criteria":{"$ref":"#/definitions/catalog-inventory-stock-status-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"catalog-inventory-data-stock-status-interface":{"type":"object","description":"Interface StockStatusInterface","properties":{"product_id":{"type":"integer"},"stock_id":{"type":"integer"},"qty":{"type":"integer"},"stock_status":{"type":"integer"},"stock_item":{"$ref":"#/definitions/catalog-inventory-data-stock-item-interface"},"extension_attributes":{"$ref":"#/definitions/catalog-inventory-data-stock-status-extension-interface"}},"required":["product_id","stock_id","qty","stock_status","stock_item"]},"catalog-inventory-data-stock-status-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\CatalogInventory\\Api\\Data\\StockStatusInterface"},"catalog-inventory-stock-status-criteria-interface":{"type":"object","description":"Interface StockStatusCriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"framework-criteria-interface":{"type":"object","description":"Interface CriteriaInterface","properties":{"mapper_interface_name":{"type":"string","description":"Associated Mapper Interface name"},"criteria_list":{"type":"array","description":"Criteria objects added to current Composite Criteria","items":{"$ref":"#/definitions/framework-criteria-interface"}},"filters":{"type":"array","description":"List of filters","items":{"type":"string"}},"orders":{"type":"array","description":"Ordering criteria","items":{"type":"string"}},"limit":{"type":"array","description":"Limit","items":{"type":"string"}}},"required":["mapper_interface_name","criteria_list","filters","orders","limit"]},"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","base_discount_tax_compensation_amount","base_discount_tax_compensation_invoiced","base_discount_tax_compensation_refunded","base_shipping_discount_tax_compensation_amnt","customer_email","grand_total","discount_tax_compensation_amount","discount_tax_compensation_invoiced","discount_tax_compensation_refunded","shipping_discount_tax_compensation_amount","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":["base_discount_tax_compensation_amount","base_discount_tax_compensation_invoiced","base_discount_tax_compensation_refunded","discount_tax_compensation_amount","discount_tax_compensation_canceled","discount_tax_compensation_invoiced","discount_tax_compensation_refunded","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"}},"downloadable_option":{"$ref":"#/definitions/downloadable-data-downloadable-option-interface"},"configurable_item_options":{"type":"array","items":{"$ref":"#/definitions/configurable-product-data-configurable-item-option-value-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"}}},"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"}},"gift_message":{"$ref":"#/definitions/gift-message-data-message-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"}}},"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"}},"required":["base_shipping_discount_tax_compensation_amnt","shipping_discount_tax_compensation_amount"]},"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"},"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"},"sales-data-order-search-result-interface":{"type":"object","description":"Order search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-status-history-search-result-interface":{"type":"object","description":"Order status history search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-status-history-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-order-item-search-result-interface":{"type":"object","description":"Order item search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-order-item-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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":["base_discount_tax_compensation_amount","base_shipping_discount_tax_compensation_amnt","discount_tax_compensation_amount","order_id","shipping_discount_tax_compensation_amount","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."},"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."},"extension_attributes":{"$ref":"#/definitions/sales-data-invoice-item-extension-interface"}},"required":["base_discount_tax_compensation_amount","discount_tax_compensation_amount","order_item_id","qty","sku"]},"sales-data-invoice-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\InvoiceItemInterface"},"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":{"comment":{"type":"string","description":"Comment."},"created_at":{"type":"string","description":"Created-at timestamp."},"entity_id":{"type":"integer","description":"Invoice 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-invoice-comment-extension-interface"}},"required":["comment","is_customer_notified","is_visible_on_front","parent_id"]},"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"},"sales-data-invoice-search-result-interface":{"type":"object","description":"Invoice search result interface. An invoice is a record of the receipt of payment for an order.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-invoice-comment-search-result-interface":{"type":"object","description":"Invoice comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-invoice-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-creditmemo-comment-search-result-interface":{"type":"object","description":"Credit memo comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-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":["base_discount_tax_compensation_amount","base_shipping_discount_tax_compensation_amnt","discount_tax_compensation_amount","order_id","shipping_discount_tax_compensation_amount","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_discount_amount","base_discount_tax_compensation_amount","base_price","entity_id","discount_tax_compensation_amount","order_item_id","qty"]},"sales-data-creditmemo-item-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoItemInterface"},"sales-data-creditmemo-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\CreditmemoInterface"},"sales-data-creditmemo-search-result-interface":{"type":"object","description":"Credit memo search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-creditmemo-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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."},"order_item_id":{"type":"integer","description":"Order item ID."},"parent_id":{"type":"integer","description":"Parent ID."},"price":{"type":"number","description":"Price."},"product_id":{"type":"integer","description":"Product ID."},"qty":{"type":"number","description":"Quantity."},"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"}},"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":{"carrier_code":{"type":"string","description":"Carrier code."},"created_at":{"type":"string","description":"Created-at timestamp."},"description":{"type":"string","description":"Description."},"entity_id":{"type":"integer","description":"Shipment package ID."},"order_id":{"type":"integer","description":"The order_id for the shipment package."},"parent_id":{"type":"integer","description":"Parent ID."},"qty":{"type":"number","description":"Quantity."},"title":{"type":"string","description":"Title."},"track_number":{"type":"string","description":"Track number."},"updated_at":{"type":"string","description":"Updated-at timestamp."},"weight":{"type":"number","description":"Weight."},"extension_attributes":{"$ref":"#/definitions/sales-data-shipment-track-extension-interface"}},"required":["carrier_code","description","order_id","parent_id","qty","title","track_number","weight"]},"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":{"comment":{"type":"string","description":"Comment."},"created_at":{"type":"string","description":"Created-at timestamp."},"entity_id":{"type":"integer","description":"Shipment comment 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-shipment-comment-extension-interface"}},"required":["comment","is_customer_notified","is_visible_on_front","parent_id"]},"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"},"sales-data-shipment-search-result-interface":{"type":"object","description":"Shipment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-shipment-comment-search-result-interface":{"type":"object","description":"Shipment comment search result 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":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-shipment-comment-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"sales-data-transaction-interface":{"type":"object","description":"Transaction interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"transaction_id":{"type":"integer","description":"Transaction ID."},"parent_id":{"type":"integer","description":"The parent ID for the transaction. Otherwise, null."},"order_id":{"type":"integer","description":"Order ID."},"payment_id":{"type":"integer","description":"Payment ID."},"txn_id":{"type":"string","description":"Transaction business ID."},"parent_txn_id":{"type":"string","description":"Parent transaction business ID."},"txn_type":{"type":"string","description":"Transaction type."},"is_closed":{"type":"integer","description":"Is-closed flag value."},"additional_information":{"type":"array","description":"Array of additional information. Otherwise, null.","items":{"type":"string"}},"created_at":{"type":"string","description":"Created-at timestamp."},"child_transactions":{"type":"array","description":"Array of child transactions.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"extension_attributes":{"$ref":"#/definitions/sales-data-transaction-extension-interface"}},"required":["transaction_id","order_id","payment_id","txn_id","parent_txn_id","txn_type","is_closed","created_at","child_transactions"]},"sales-data-transaction-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Sales\\Api\\Data\\TransactionInterface"},"sales-data-transaction-search-result-interface":{"type":"object","description":"Transaction search result interface. A transaction is an interaction between a merchant and a customer such as a purchase, a credit, a refund, and so on.","properties":{"items":{"type":"array","description":"Array of collection items.","items":{"$ref":"#/definitions/sales-data-transaction-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-payment-details-interface":{"type":"object","description":"Interface PaymentDetailsInterface","properties":{"payment_methods":{"type":"array","items":{"$ref":"#/definitions/quote-data-payment-method-interface"}},"totals":{"$ref":"#/definitions/quote-data-totals-interface"},"extension_attributes":{"$ref":"#/definitions/checkout-data-payment-details-extension-interface"}},"required":["payment_methods","totals"]},"checkout-data-payment-details-extension-interface":{"type":"object","description":"ExtensionInterface class for @see \\Magento\\Checkout\\Api\\Data\\PaymentDetailsInterface"},"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"},"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-rate-search-results-interface":{"type":"object","description":"Interface for tax rate search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rate-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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-rule-search-results-interface":{"type":"object","description":"Interface for tax rule search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"tax-data-tax-class-search-results-interface":{"type":"object","description":"Interface for tax class search results.","properties":{"items":{"type":"array","description":"Items","items":{"$ref":"#/definitions/tax-data-tax-class-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-rule-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-rule-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-search-result-interface":{"type":"object","description":"","properties":{"items":{"type":"array","description":"Rules.","items":{"$ref":"#/definitions/sales-rule-data-coupon-interface"}},"search_criteria":{"$ref":"#/definitions/framework-search-criteria-interface"},"total_count":{"type":"integer","description":"Total count."}},"required":["items","search_criteria","total_count"]},"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"},"sales-rule-data-coupon-mass-delete-result-interface":{"type":"object","description":"Coupon mass delete results interface.","properties":{"failed_items":{"type":"array","description":"List of failed items.","items":{"type":"string"}},"missing_items":{"type":"array","description":"List of missing items.","items":{"type":"string"}}},"required":["failed_items","missing_items"]}}} - diff --git a/src/swagger/swagger-ui-bundle.js b/src/swagger/swagger-ui-bundle.js deleted file mode 100644 index 54d90a9842c..00000000000 --- a/src/swagger/swagger-ui-bundle.js +++ /dev/null @@ -1,3 +0,0 @@ -/*! For license information please see swagger-ui-bundle.js.LICENSE.txt */ -!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(function(){try{return require("esprima")}catch(e){}}()):"function"==typeof define&&define.amd?define(["esprima"],t):"object"==typeof exports?exports.SwaggerUIBundle=t(function(){try{return require("esprima")}catch(e){}}()):e.SwaggerUIBundle=t(e.esprima)}(this,(function(e){return function(e){var t={};function n(r){if(t[r])return t[r].exports;var o=t[r]={i:r,l:!1,exports:{}};return e[r].call(o.exports,o,o.exports,n),o.l=!0,o.exports}return n.m=e,n.c=t,n.d=function(e,t,r){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:r})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var r=Object.create(null);if(n.r(r),Object.defineProperty(r,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)n.d(r,o,function(t){return e[t]}.bind(null,o));return r},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="/dist",n(n.s=540)}([function(e,t,n){"use strict";e.exports=n(128)},function(e,t,n){e.exports=function(){"use strict";var e=Array.prototype.slice;function t(e,t){t&&(e.prototype=Object.create(t.prototype)),e.prototype.constructor=e}function n(e){return i(e)?e:$(e)}function r(e){return s(e)?e:K(e)}function o(e){return u(e)?e:Y(e)}function a(e){return i(e)&&!c(e)?e:G(e)}function i(e){return!(!e||!e[p])}function s(e){return!(!e||!e[f])}function u(e){return!(!e||!e[h])}function c(e){return s(e)||u(e)}function l(e){return!(!e||!e[d])}t(r,n),t(o,n),t(a,n),n.isIterable=i,n.isKeyed=s,n.isIndexed=u,n.isAssociative=c,n.isOrdered=l,n.Keyed=r,n.Indexed=o,n.Set=a;var p="@@__IMMUTABLE_ITERABLE__@@",f="@@__IMMUTABLE_KEYED__@@",h="@@__IMMUTABLE_INDEXED__@@",d="@@__IMMUTABLE_ORDERED__@@",v="delete",m=5,g=1<>>0;if(""+n!==t||4294967295===n)return NaN;t=n}return t<0?A(e)+t:t}function O(){return!0}function j(e,t,n){return(0===e||void 0!==n&&e<=-n)&&(void 0===t||void 0!==n&&t>=n)}function T(e,t){return N(e,t,0)}function I(e,t){return N(e,t,t)}function N(e,t,n){return void 0===e?n:e<0?Math.max(0,t+e):void 0===t?e:Math.min(t,e)}var M=0,P=1,R=2,D="function"==typeof Symbol&&Symbol.iterator,L="@@iterator",B=D||L;function F(e){this.next=e}function U(e,t,n,r){var o=0===e?t:1===e?n:[t,n];return r?r.value=o:r={value:o,done:!1},r}function q(){return{value:void 0,done:!0}}function z(e){return!!H(e)}function V(e){return e&&"function"==typeof e.next}function W(e){var t=H(e);return t&&t.call(e)}function H(e){var t=e&&(D&&e[D]||e[L]);if("function"==typeof t)return t}function J(e){return e&&"number"==typeof e.length}function $(e){return null==e?ie():i(e)?e.toSeq():ce(e)}function K(e){return null==e?ie().toKeyedSeq():i(e)?s(e)?e.toSeq():e.fromEntrySeq():se(e)}function Y(e){return null==e?ie():i(e)?s(e)?e.entrySeq():e.toIndexedSeq():ue(e)}function G(e){return(null==e?ie():i(e)?s(e)?e.entrySeq():e:ue(e)).toSetSeq()}F.prototype.toString=function(){return"[Iterator]"},F.KEYS=M,F.VALUES=P,F.ENTRIES=R,F.prototype.inspect=F.prototype.toSource=function(){return this.toString()},F.prototype[B]=function(){return this},t($,n),$.of=function(){return $(arguments)},$.prototype.toSeq=function(){return this},$.prototype.toString=function(){return this.__toString("Seq {","}")},$.prototype.cacheResult=function(){return!this._cache&&this.__iterateUncached&&(this._cache=this.entrySeq().toArray(),this.size=this._cache.length),this},$.prototype.__iterate=function(e,t){return pe(this,e,t,!0)},$.prototype.__iterator=function(e,t){return fe(this,e,t,!0)},t(K,$),K.prototype.toKeyedSeq=function(){return this},t(Y,$),Y.of=function(){return Y(arguments)},Y.prototype.toIndexedSeq=function(){return this},Y.prototype.toString=function(){return this.__toString("Seq [","]")},Y.prototype.__iterate=function(e,t){return pe(this,e,t,!1)},Y.prototype.__iterator=function(e,t){return fe(this,e,t,!1)},t(G,$),G.of=function(){return G(arguments)},G.prototype.toSetSeq=function(){return this},$.isSeq=ae,$.Keyed=K,$.Set=G,$.Indexed=Y;var Z,X,Q,ee="@@__IMMUTABLE_SEQ__@@";function te(e){this._array=e,this.size=e.length}function ne(e){var t=Object.keys(e);this._object=e,this._keys=t,this.size=t.length}function re(e){this._iterable=e,this.size=e.length||e.size}function oe(e){this._iterator=e,this._iteratorCache=[]}function ae(e){return!(!e||!e[ee])}function ie(){return Z||(Z=new te([]))}function se(e){var t=Array.isArray(e)?new te(e).fromEntrySeq():V(e)?new oe(e).fromEntrySeq():z(e)?new re(e).fromEntrySeq():"object"==typeof e?new ne(e):void 0;if(!t)throw new TypeError("Expected Array or iterable object of [k, v] entries, or keyed object: "+e);return t}function ue(e){var t=le(e);if(!t)throw new TypeError("Expected Array or iterable object of values: "+e);return t}function ce(e){var t=le(e)||"object"==typeof e&&new ne(e);if(!t)throw new TypeError("Expected Array or iterable object of values, or keyed object: "+e);return t}function le(e){return J(e)?new te(e):V(e)?new oe(e):z(e)?new re(e):void 0}function pe(e,t,n,r){var o=e._cache;if(o){for(var a=o.length-1,i=0;i<=a;i++){var s=o[n?a-i:i];if(!1===t(s[1],r?s[0]:i,e))return i+1}return i}return e.__iterateUncached(t,n)}function fe(e,t,n,r){var o=e._cache;if(o){var a=o.length-1,i=0;return new F((function(){var e=o[n?a-i:i];return i++>a?q():U(t,r?e[0]:i-1,e[1])}))}return e.__iteratorUncached(t,n)}function he(e,t){return t?de(t,e,"",{"":e}):ve(e)}function de(e,t,n,r){return Array.isArray(t)?e.call(r,n,Y(t).map((function(n,r){return de(e,n,r,t)}))):me(t)?e.call(r,n,K(t).map((function(n,r){return de(e,n,r,t)}))):t}function ve(e){return Array.isArray(e)?Y(e).map(ve).toList():me(e)?K(e).map(ve).toMap():e}function me(e){return e&&(e.constructor===Object||void 0===e.constructor)}function ge(e,t){if(e===t||e!=e&&t!=t)return!0;if(!e||!t)return!1;if("function"==typeof e.valueOf&&"function"==typeof t.valueOf){if((e=e.valueOf())===(t=t.valueOf())||e!=e&&t!=t)return!0;if(!e||!t)return!1}return!("function"!=typeof e.equals||"function"!=typeof t.equals||!e.equals(t))}function ye(e,t){if(e===t)return!0;if(!i(t)||void 0!==e.size&&void 0!==t.size&&e.size!==t.size||void 0!==e.__hash&&void 0!==t.__hash&&e.__hash!==t.__hash||s(e)!==s(t)||u(e)!==u(t)||l(e)!==l(t))return!1;if(0===e.size&&0===t.size)return!0;var n=!c(e);if(l(e)){var r=e.entries();return t.every((function(e,t){var o=r.next().value;return o&&ge(o[1],e)&&(n||ge(o[0],t))}))&&r.next().done}var o=!1;if(void 0===e.size)if(void 0===t.size)"function"==typeof e.cacheResult&&e.cacheResult();else{o=!0;var a=e;e=t,t=a}var p=!0,f=t.__iterate((function(t,r){if(n?!e.has(t):o?!ge(t,e.get(r,b)):!ge(e.get(r,b),t))return p=!1,!1}));return p&&e.size===f}function be(e,t){if(!(this instanceof be))return new be(e,t);if(this._value=e,this.size=void 0===t?1/0:Math.max(0,t),0===this.size){if(X)return X;X=this}}function _e(e,t){if(!e)throw new Error(t)}function we(e,t,n){if(!(this instanceof we))return new we(e,t,n);if(_e(0!==n,"Cannot step a Range by 0"),e=e||0,void 0===t&&(t=1/0),n=void 0===n?1:Math.abs(n),tr?q():U(e,o,n[t?r-o++:o++])}))},t(ne,K),ne.prototype.get=function(e,t){return void 0===t||this.has(e)?this._object[e]:t},ne.prototype.has=function(e){return this._object.hasOwnProperty(e)},ne.prototype.__iterate=function(e,t){for(var n=this._object,r=this._keys,o=r.length-1,a=0;a<=o;a++){var i=r[t?o-a:a];if(!1===e(n[i],i,this))return a+1}return a},ne.prototype.__iterator=function(e,t){var n=this._object,r=this._keys,o=r.length-1,a=0;return new F((function(){var i=r[t?o-a:a];return a++>o?q():U(e,i,n[i])}))},ne.prototype[d]=!0,t(re,Y),re.prototype.__iterateUncached=function(e,t){if(t)return this.cacheResult().__iterate(e,t);var n=W(this._iterable),r=0;if(V(n))for(var o;!(o=n.next()).done&&!1!==e(o.value,r++,this););return r},re.prototype.__iteratorUncached=function(e,t){if(t)return this.cacheResult().__iterator(e,t);var n=W(this._iterable);if(!V(n))return new F(q);var r=0;return new F((function(){var t=n.next();return t.done?t:U(e,r++,t.value)}))},t(oe,Y),oe.prototype.__iterateUncached=function(e,t){if(t)return this.cacheResult().__iterate(e,t);for(var n,r=this._iterator,o=this._iteratorCache,a=0;a=r.length){var t=n.next();if(t.done)return t;r[o]=t.value}return U(e,o,r[o++])}))},t(be,Y),be.prototype.toString=function(){return 0===this.size?"Repeat []":"Repeat [ "+this._value+" "+this.size+" times ]"},be.prototype.get=function(e,t){return this.has(e)?this._value:t},be.prototype.includes=function(e){return ge(this._value,e)},be.prototype.slice=function(e,t){var n=this.size;return j(e,t,n)?this:new be(this._value,I(t,n)-T(e,n))},be.prototype.reverse=function(){return this},be.prototype.indexOf=function(e){return ge(this._value,e)?0:-1},be.prototype.lastIndexOf=function(e){return ge(this._value,e)?this.size:-1},be.prototype.__iterate=function(e,t){for(var n=0;n=0&&t=0&&nn?q():U(e,a++,i)}))},we.prototype.equals=function(e){return e instanceof we?this._start===e._start&&this._end===e._end&&this._step===e._step:ye(this,e)},t(xe,n),t(Ee,xe),t(Ce,xe),t(Se,xe),xe.Keyed=Ee,xe.Indexed=Ce,xe.Set=Se;var Ae="function"==typeof Math.imul&&-2===Math.imul(4294967295,2)?Math.imul:function(e,t){var n=65535&(e|=0),r=65535&(t|=0);return n*r+((e>>>16)*r+n*(t>>>16)<<16>>>0)|0};function ke(e){return e>>>1&1073741824|3221225471&e}function Oe(e){if(!1===e||null==e)return 0;if("function"==typeof e.valueOf&&(!1===(e=e.valueOf())||null==e))return 0;if(!0===e)return 1;var t=typeof e;if("number"===t){if(e!=e||e===1/0)return 0;var n=0|e;for(n!==e&&(n^=4294967295*e);e>4294967295;)n^=e/=4294967295;return ke(n)}if("string"===t)return e.length>Fe?je(e):Te(e);if("function"==typeof e.hashCode)return e.hashCode();if("object"===t)return Ie(e);if("function"==typeof e.toString)return Te(e.toString());throw new Error("Value type "+t+" cannot be hashed.")}function je(e){var t=ze[e];return void 0===t&&(t=Te(e),qe===Ue&&(qe=0,ze={}),qe++,ze[e]=t),t}function Te(e){for(var t=0,n=0;n0)switch(e.nodeType){case 1:return e.uniqueID;case 9:return e.documentElement&&e.documentElement.uniqueID}}var Re,De="function"==typeof WeakMap;De&&(Re=new WeakMap);var Le=0,Be="__immutablehash__";"function"==typeof Symbol&&(Be=Symbol(Be));var Fe=16,Ue=255,qe=0,ze={};function Ve(e){_e(e!==1/0,"Cannot perform this action with an infinite size.")}function We(e){return null==e?ot():He(e)&&!l(e)?e:ot().withMutations((function(t){var n=r(e);Ve(n.size),n.forEach((function(e,n){return t.set(n,e)}))}))}function He(e){return!(!e||!e[$e])}t(We,Ee),We.of=function(){var t=e.call(arguments,0);return ot().withMutations((function(e){for(var n=0;n=t.length)throw new Error("Missing value for key: "+t[n]);e.set(t[n],t[n+1])}}))},We.prototype.toString=function(){return this.__toString("Map {","}")},We.prototype.get=function(e,t){return this._root?this._root.get(0,void 0,e,t):t},We.prototype.set=function(e,t){return at(this,e,t)},We.prototype.setIn=function(e,t){return this.updateIn(e,b,(function(){return t}))},We.prototype.remove=function(e){return at(this,e,b)},We.prototype.deleteIn=function(e){return this.updateIn(e,(function(){return b}))},We.prototype.update=function(e,t,n){return 1===arguments.length?e(this):this.updateIn([e],t,n)},We.prototype.updateIn=function(e,t,n){n||(n=t,t=void 0);var r=mt(this,xn(e),t,n);return r===b?void 0:r},We.prototype.clear=function(){return 0===this.size?this:this.__ownerID?(this.size=0,this._root=null,this.__hash=void 0,this.__altered=!0,this):ot()},We.prototype.merge=function(){return ft(this,void 0,arguments)},We.prototype.mergeWith=function(t){return ft(this,t,e.call(arguments,1))},We.prototype.mergeIn=function(t){var n=e.call(arguments,1);return this.updateIn(t,ot(),(function(e){return"function"==typeof e.merge?e.merge.apply(e,n):n[n.length-1]}))},We.prototype.mergeDeep=function(){return ft(this,ht,arguments)},We.prototype.mergeDeepWith=function(t){var n=e.call(arguments,1);return ft(this,dt(t),n)},We.prototype.mergeDeepIn=function(t){var n=e.call(arguments,1);return this.updateIn(t,ot(),(function(e){return"function"==typeof e.mergeDeep?e.mergeDeep.apply(e,n):n[n.length-1]}))},We.prototype.sort=function(e){return zt(pn(this,e))},We.prototype.sortBy=function(e,t){return zt(pn(this,t,e))},We.prototype.withMutations=function(e){var t=this.asMutable();return e(t),t.wasAltered()?t.__ensureOwner(this.__ownerID):this},We.prototype.asMutable=function(){return this.__ownerID?this:this.__ensureOwner(new C)},We.prototype.asImmutable=function(){return this.__ensureOwner()},We.prototype.wasAltered=function(){return this.__altered},We.prototype.__iterator=function(e,t){return new et(this,e,t)},We.prototype.__iterate=function(e,t){var n=this,r=0;return this._root&&this._root.iterate((function(t){return r++,e(t[1],t[0],n)}),t),r},We.prototype.__ensureOwner=function(e){return e===this.__ownerID?this:e?rt(this.size,this._root,e,this.__hash):(this.__ownerID=e,this.__altered=!1,this)},We.isMap=He;var Je,$e="@@__IMMUTABLE_MAP__@@",Ke=We.prototype;function Ye(e,t){this.ownerID=e,this.entries=t}function Ge(e,t,n){this.ownerID=e,this.bitmap=t,this.nodes=n}function Ze(e,t,n){this.ownerID=e,this.count=t,this.nodes=n}function Xe(e,t,n){this.ownerID=e,this.keyHash=t,this.entries=n}function Qe(e,t,n){this.ownerID=e,this.keyHash=t,this.entry=n}function et(e,t,n){this._type=t,this._reverse=n,this._stack=e._root&&nt(e._root)}function tt(e,t){return U(e,t[0],t[1])}function nt(e,t){return{node:e,index:0,__prev:t}}function rt(e,t,n,r){var o=Object.create(Ke);return o.size=e,o._root=t,o.__ownerID=n,o.__hash=r,o.__altered=!1,o}function ot(){return Je||(Je=rt(0))}function at(e,t,n){var r,o;if(e._root){var a=x(_),i=x(w);if(r=it(e._root,e.__ownerID,0,void 0,t,n,a,i),!i.value)return e;o=e.size+(a.value?n===b?-1:1:0)}else{if(n===b)return e;o=1,r=new Ye(e.__ownerID,[[t,n]])}return e.__ownerID?(e.size=o,e._root=r,e.__hash=void 0,e.__altered=!0,e):r?rt(o,r):ot()}function it(e,t,n,r,o,a,i,s){return e?e.update(t,n,r,o,a,i,s):a===b?e:(E(s),E(i),new Qe(t,r,[o,a]))}function st(e){return e.constructor===Qe||e.constructor===Xe}function ut(e,t,n,r,o){if(e.keyHash===r)return new Xe(t,r,[e.entry,o]);var a,i=(0===n?e.keyHash:e.keyHash>>>n)&y,s=(0===n?r:r>>>n)&y;return new Ge(t,1<>>=1)i[s]=1&n?t[a++]:void 0;return i[r]=o,new Ze(e,a+1,i)}function ft(e,t,n){for(var o=[],a=0;a>1&1431655765))+(e>>2&858993459))+(e>>4)&252645135,e+=e>>8,127&(e+=e>>16)}function yt(e,t,n,r){var o=r?e:S(e);return o[t]=n,o}function bt(e,t,n,r){var o=e.length+1;if(r&&t+1===o)return e[t]=n,e;for(var a=new Array(o),i=0,s=0;s=wt)return ct(e,u,r,o);var f=e&&e===this.ownerID,h=f?u:S(u);return p?s?c===l-1?h.pop():h[c]=h.pop():h[c]=[r,o]:h.push([r,o]),f?(this.entries=h,this):new Ye(e,h)}},Ge.prototype.get=function(e,t,n,r){void 0===t&&(t=Oe(n));var o=1<<((0===e?t:t>>>e)&y),a=this.bitmap;return 0==(a&o)?r:this.nodes[gt(a&o-1)].get(e+m,t,n,r)},Ge.prototype.update=function(e,t,n,r,o,a,i){void 0===n&&(n=Oe(r));var s=(0===t?n:n>>>t)&y,u=1<=xt)return pt(e,f,c,s,d);if(l&&!d&&2===f.length&&st(f[1^p]))return f[1^p];if(l&&d&&1===f.length&&st(d))return d;var v=e&&e===this.ownerID,g=l?d?c:c^u:c|u,_=l?d?yt(f,p,d,v):_t(f,p,v):bt(f,p,d,v);return v?(this.bitmap=g,this.nodes=_,this):new Ge(e,g,_)},Ze.prototype.get=function(e,t,n,r){void 0===t&&(t=Oe(n));var o=(0===e?t:t>>>e)&y,a=this.nodes[o];return a?a.get(e+m,t,n,r):r},Ze.prototype.update=function(e,t,n,r,o,a,i){void 0===n&&(n=Oe(r));var s=(0===t?n:n>>>t)&y,u=o===b,c=this.nodes,l=c[s];if(u&&!l)return this;var p=it(l,e,t+m,n,r,o,a,i);if(p===l)return this;var f=this.count;if(l){if(!p&&--f0&&r=0&&e>>t&y;if(r>=this.array.length)return new Ot([],e);var o,a=0===r;if(t>0){var i=this.array[r];if((o=i&&i.removeBefore(e,t-m,n))===i&&a)return this}if(a&&!o)return this;var s=Lt(this,e);if(!a)for(var u=0;u>>t&y;if(o>=this.array.length)return this;if(t>0){var a=this.array[o];if((r=a&&a.removeAfter(e,t-m,n))===a&&o===this.array.length-1)return this}var i=Lt(this,e);return i.array.splice(o+1),r&&(i.array[o]=r),i};var jt,Tt,It={};function Nt(e,t){var n=e._origin,r=e._capacity,o=qt(r),a=e._tail;return i(e._root,e._level,0);function i(e,t,n){return 0===t?s(e,n):u(e,t,n)}function s(e,i){var s=i===o?a&&a.array:e&&e.array,u=i>n?0:n-i,c=r-i;return c>g&&(c=g),function(){if(u===c)return It;var e=t?--c:u++;return s&&s[e]}}function u(e,o,a){var s,u=e&&e.array,c=a>n?0:n-a>>o,l=1+(r-a>>o);return l>g&&(l=g),function(){for(;;){if(s){var e=s();if(e!==It)return e;s=null}if(c===l)return It;var n=t?--l:c++;s=i(u&&u[n],o-m,a+(n<=e.size||t<0)return e.withMutations((function(e){t<0?Ft(e,t).set(0,n):Ft(e,0,t+1).set(t,n)}));t+=e._origin;var r=e._tail,o=e._root,a=x(w);return t>=qt(e._capacity)?r=Dt(r,e.__ownerID,0,t,n,a):o=Dt(o,e.__ownerID,e._level,t,n,a),a.value?e.__ownerID?(e._root=o,e._tail=r,e.__hash=void 0,e.__altered=!0,e):Mt(e._origin,e._capacity,e._level,o,r):e}function Dt(e,t,n,r,o,a){var i,s=r>>>n&y,u=e&&s0){var c=e&&e.array[s],l=Dt(c,t,n-m,r,o,a);return l===c?e:((i=Lt(e,t)).array[s]=l,i)}return u&&e.array[s]===o?e:(E(a),i=Lt(e,t),void 0===o&&s===i.array.length-1?i.array.pop():i.array[s]=o,i)}function Lt(e,t){return t&&e&&t===e.ownerID?e:new Ot(e?e.array.slice():[],t)}function Bt(e,t){if(t>=qt(e._capacity))return e._tail;if(t<1<0;)n=n.array[t>>>r&y],r-=m;return n}}function Ft(e,t,n){void 0!==t&&(t|=0),void 0!==n&&(n|=0);var r=e.__ownerID||new C,o=e._origin,a=e._capacity,i=o+t,s=void 0===n?a:n<0?a+n:o+n;if(i===o&&s===a)return e;if(i>=s)return e.clear();for(var u=e._level,c=e._root,l=0;i+l<0;)c=new Ot(c&&c.array.length?[void 0,c]:[],r),l+=1<<(u+=m);l&&(i+=l,o+=l,s+=l,a+=l);for(var p=qt(a),f=qt(s);f>=1<p?new Ot([],r):h;if(h&&f>p&&im;g-=m){var b=p>>>g&y;v=v.array[b]=Lt(v.array[b],r)}v.array[p>>>m&y]=h}if(s=f)i-=f,s-=f,u=m,c=null,d=d&&d.removeBefore(r,0,i);else if(i>o||f>>u&y;if(_!==f>>>u&y)break;_&&(l+=(1<o&&(c=c.removeBefore(r,u,i-l)),c&&fa&&(a=c.size),i(u)||(c=c.map((function(e){return he(e)}))),r.push(c)}return a>e.size&&(e=e.setSize(a)),vt(e,t,r)}function qt(e){return e>>m<=g&&i.size>=2*a.size?(r=(o=i.filter((function(e,t){return void 0!==e&&s!==t}))).toKeyedSeq().map((function(e){return e[0]})).flip().toMap(),e.__ownerID&&(r.__ownerID=o.__ownerID=e.__ownerID)):(r=a.remove(t),o=s===i.size-1?i.pop():i.set(s,void 0))}else if(u){if(n===i.get(s)[1])return e;r=a,o=i.set(s,[t,n])}else r=a.set(t,i.size),o=i.set(i.size,[t,n]);return e.__ownerID?(e.size=r.size,e._map=r,e._list=o,e.__hash=void 0,e):Wt(r,o)}function $t(e,t){this._iter=e,this._useKeys=t,this.size=e.size}function Kt(e){this._iter=e,this.size=e.size}function Yt(e){this._iter=e,this.size=e.size}function Gt(e){this._iter=e,this.size=e.size}function Zt(e){var t=bn(e);return t._iter=e,t.size=e.size,t.flip=function(){return e},t.reverse=function(){var t=e.reverse.apply(this);return t.flip=function(){return e.reverse()},t},t.has=function(t){return e.includes(t)},t.includes=function(t){return e.has(t)},t.cacheResult=_n,t.__iterateUncached=function(t,n){var r=this;return e.__iterate((function(e,n){return!1!==t(n,e,r)}),n)},t.__iteratorUncached=function(t,n){if(t===R){var r=e.__iterator(t,n);return new F((function(){var e=r.next();if(!e.done){var t=e.value[0];e.value[0]=e.value[1],e.value[1]=t}return e}))}return e.__iterator(t===P?M:P,n)},t}function Xt(e,t,n){var r=bn(e);return r.size=e.size,r.has=function(t){return e.has(t)},r.get=function(r,o){var a=e.get(r,b);return a===b?o:t.call(n,a,r,e)},r.__iterateUncached=function(r,o){var a=this;return e.__iterate((function(e,o,i){return!1!==r(t.call(n,e,o,i),o,a)}),o)},r.__iteratorUncached=function(r,o){var a=e.__iterator(R,o);return new F((function(){var o=a.next();if(o.done)return o;var i=o.value,s=i[0];return U(r,s,t.call(n,i[1],s,e),o)}))},r}function Qt(e,t){var n=bn(e);return n._iter=e,n.size=e.size,n.reverse=function(){return e},e.flip&&(n.flip=function(){var t=Zt(e);return t.reverse=function(){return e.flip()},t}),n.get=function(n,r){return e.get(t?n:-1-n,r)},n.has=function(n){return e.has(t?n:-1-n)},n.includes=function(t){return e.includes(t)},n.cacheResult=_n,n.__iterate=function(t,n){var r=this;return e.__iterate((function(e,n){return t(e,n,r)}),!n)},n.__iterator=function(t,n){return e.__iterator(t,!n)},n}function en(e,t,n,r){var o=bn(e);return r&&(o.has=function(r){var o=e.get(r,b);return o!==b&&!!t.call(n,o,r,e)},o.get=function(r,o){var a=e.get(r,b);return a!==b&&t.call(n,a,r,e)?a:o}),o.__iterateUncached=function(o,a){var i=this,s=0;return e.__iterate((function(e,a,u){if(t.call(n,e,a,u))return s++,o(e,r?a:s-1,i)}),a),s},o.__iteratorUncached=function(o,a){var i=e.__iterator(R,a),s=0;return new F((function(){for(;;){var a=i.next();if(a.done)return a;var u=a.value,c=u[0],l=u[1];if(t.call(n,l,c,e))return U(o,r?c:s++,l,a)}}))},o}function tn(e,t,n){var r=We().asMutable();return e.__iterate((function(o,a){r.update(t.call(n,o,a,e),0,(function(e){return e+1}))})),r.asImmutable()}function nn(e,t,n){var r=s(e),o=(l(e)?zt():We()).asMutable();e.__iterate((function(a,i){o.update(t.call(n,a,i,e),(function(e){return(e=e||[]).push(r?[i,a]:a),e}))}));var a=yn(e);return o.map((function(t){return vn(e,a(t))}))}function rn(e,t,n,r){var o=e.size;if(void 0!==t&&(t|=0),void 0!==n&&(n===1/0?n=o:n|=0),j(t,n,o))return e;var a=T(t,o),i=I(n,o);if(a!=a||i!=i)return rn(e.toSeq().cacheResult(),t,n,r);var s,u=i-a;u==u&&(s=u<0?0:u);var c=bn(e);return c.size=0===s?s:e.size&&s||void 0,!r&&ae(e)&&s>=0&&(c.get=function(t,n){return(t=k(this,t))>=0&&ts)return q();var e=o.next();return r||t===P?e:U(t,u-1,t===M?void 0:e.value[1],e)}))},c}function on(e,t,n){var r=bn(e);return r.__iterateUncached=function(r,o){var a=this;if(o)return this.cacheResult().__iterate(r,o);var i=0;return e.__iterate((function(e,o,s){return t.call(n,e,o,s)&&++i&&r(e,o,a)})),i},r.__iteratorUncached=function(r,o){var a=this;if(o)return this.cacheResult().__iterator(r,o);var i=e.__iterator(R,o),s=!0;return new F((function(){if(!s)return q();var e=i.next();if(e.done)return e;var o=e.value,u=o[0],c=o[1];return t.call(n,c,u,a)?r===R?e:U(r,u,c,e):(s=!1,q())}))},r}function an(e,t,n,r){var o=bn(e);return o.__iterateUncached=function(o,a){var i=this;if(a)return this.cacheResult().__iterate(o,a);var s=!0,u=0;return e.__iterate((function(e,a,c){if(!s||!(s=t.call(n,e,a,c)))return u++,o(e,r?a:u-1,i)})),u},o.__iteratorUncached=function(o,a){var i=this;if(a)return this.cacheResult().__iterator(o,a);var s=e.__iterator(R,a),u=!0,c=0;return new F((function(){var e,a,l;do{if((e=s.next()).done)return r||o===P?e:U(o,c++,o===M?void 0:e.value[1],e);var p=e.value;a=p[0],l=p[1],u&&(u=t.call(n,l,a,i))}while(u);return o===R?e:U(o,a,l,e)}))},o}function sn(e,t){var n=s(e),o=[e].concat(t).map((function(e){return i(e)?n&&(e=r(e)):e=n?se(e):ue(Array.isArray(e)?e:[e]),e})).filter((function(e){return 0!==e.size}));if(0===o.length)return e;if(1===o.length){var a=o[0];if(a===e||n&&s(a)||u(e)&&u(a))return a}var c=new te(o);return n?c=c.toKeyedSeq():u(e)||(c=c.toSetSeq()),(c=c.flatten(!0)).size=o.reduce((function(e,t){if(void 0!==e){var n=t.size;if(void 0!==n)return e+n}}),0),c}function un(e,t,n){var r=bn(e);return r.__iterateUncached=function(r,o){var a=0,s=!1;function u(e,c){var l=this;e.__iterate((function(e,o){return(!t||c0}function dn(e,t,r){var o=bn(e);return o.size=new te(r).map((function(e){return e.size})).min(),o.__iterate=function(e,t){for(var n,r=this.__iterator(P,t),o=0;!(n=r.next()).done&&!1!==e(n.value,o++,this););return o},o.__iteratorUncached=function(e,o){var a=r.map((function(e){return e=n(e),W(o?e.reverse():e)})),i=0,s=!1;return new F((function(){var n;return s||(n=a.map((function(e){return e.next()})),s=n.some((function(e){return e.done}))),s?q():U(e,i++,t.apply(null,n.map((function(e){return e.value}))))}))},o}function vn(e,t){return ae(e)?t:e.constructor(t)}function mn(e){if(e!==Object(e))throw new TypeError("Expected [K, V] tuple: "+e)}function gn(e){return Ve(e.size),A(e)}function yn(e){return s(e)?r:u(e)?o:a}function bn(e){return Object.create((s(e)?K:u(e)?Y:G).prototype)}function _n(){return this._iter.cacheResult?(this._iter.cacheResult(),this.size=this._iter.size,this):$.prototype.cacheResult.call(this)}function wn(e,t){return e>t?1:e=0;n--)t={value:arguments[n],next:t};return this.__ownerID?(this.size=e,this._head=t,this.__hash=void 0,this.__altered=!0,this):Kn(e,t)},Vn.prototype.pushAll=function(e){if(0===(e=o(e)).size)return this;Ve(e.size);var t=this.size,n=this._head;return e.reverse().forEach((function(e){t++,n={value:e,next:n}})),this.__ownerID?(this.size=t,this._head=n,this.__hash=void 0,this.__altered=!0,this):Kn(t,n)},Vn.prototype.pop=function(){return this.slice(1)},Vn.prototype.unshift=function(){return this.push.apply(this,arguments)},Vn.prototype.unshiftAll=function(e){return this.pushAll(e)},Vn.prototype.shift=function(){return this.pop.apply(this,arguments)},Vn.prototype.clear=function(){return 0===this.size?this:this.__ownerID?(this.size=0,this._head=void 0,this.__hash=void 0,this.__altered=!0,this):Yn()},Vn.prototype.slice=function(e,t){if(j(e,t,this.size))return this;var n=T(e,this.size);if(I(t,this.size)!==this.size)return Ce.prototype.slice.call(this,e,t);for(var r=this.size-n,o=this._head;n--;)o=o.next;return this.__ownerID?(this.size=r,this._head=o,this.__hash=void 0,this.__altered=!0,this):Kn(r,o)},Vn.prototype.__ensureOwner=function(e){return e===this.__ownerID?this:e?Kn(this.size,this._head,e,this.__hash):(this.__ownerID=e,this.__altered=!1,this)},Vn.prototype.__iterate=function(e,t){if(t)return this.reverse().__iterate(e);for(var n=0,r=this._head;r&&!1!==e(r.value,n++,this);)r=r.next;return n},Vn.prototype.__iterator=function(e,t){if(t)return this.reverse().__iterator(e);var n=0,r=this._head;return new F((function(){if(r){var t=r.value;return r=r.next,U(e,n++,t)}return q()}))},Vn.isStack=Wn;var Hn,Jn="@@__IMMUTABLE_STACK__@@",$n=Vn.prototype;function Kn(e,t,n,r){var o=Object.create($n);return o.size=e,o._head=t,o.__ownerID=n,o.__hash=r,o.__altered=!1,o}function Yn(){return Hn||(Hn=Kn(0))}function Gn(e,t){var n=function(n){e.prototype[n]=t[n]};return Object.keys(t).forEach(n),Object.getOwnPropertySymbols&&Object.getOwnPropertySymbols(t).forEach(n),e}$n[Jn]=!0,$n.withMutations=Ke.withMutations,$n.asMutable=Ke.asMutable,$n.asImmutable=Ke.asImmutable,$n.wasAltered=Ke.wasAltered,n.Iterator=F,Gn(n,{toArray:function(){Ve(this.size);var e=new Array(this.size||0);return this.valueSeq().__iterate((function(t,n){e[n]=t})),e},toIndexedSeq:function(){return new Kt(this)},toJS:function(){return this.toSeq().map((function(e){return e&&"function"==typeof e.toJS?e.toJS():e})).__toJS()},toJSON:function(){return this.toSeq().map((function(e){return e&&"function"==typeof e.toJSON?e.toJSON():e})).__toJS()},toKeyedSeq:function(){return new $t(this,!0)},toMap:function(){return We(this.toKeyedSeq())},toObject:function(){Ve(this.size);var e={};return this.__iterate((function(t,n){e[n]=t})),e},toOrderedMap:function(){return zt(this.toKeyedSeq())},toOrderedSet:function(){return Ln(s(this)?this.valueSeq():this)},toSet:function(){return jn(s(this)?this.valueSeq():this)},toSetSeq:function(){return new Yt(this)},toSeq:function(){return u(this)?this.toIndexedSeq():s(this)?this.toKeyedSeq():this.toSetSeq()},toStack:function(){return Vn(s(this)?this.valueSeq():this)},toList:function(){return Ct(s(this)?this.valueSeq():this)},toString:function(){return"[Iterable]"},__toString:function(e,t){return 0===this.size?e+t:e+" "+this.toSeq().map(this.__toStringMapper).join(", ")+" "+t},concat:function(){return vn(this,sn(this,e.call(arguments,0)))},includes:function(e){return this.some((function(t){return ge(t,e)}))},entries:function(){return this.__iterator(R)},every:function(e,t){Ve(this.size);var n=!0;return this.__iterate((function(r,o,a){if(!e.call(t,r,o,a))return n=!1,!1})),n},filter:function(e,t){return vn(this,en(this,e,t,!0))},find:function(e,t,n){var r=this.findEntry(e,t);return r?r[1]:n},forEach:function(e,t){return Ve(this.size),this.__iterate(t?e.bind(t):e)},join:function(e){Ve(this.size),e=void 0!==e?""+e:",";var t="",n=!0;return this.__iterate((function(r){n?n=!1:t+=e,t+=null!=r?r.toString():""})),t},keys:function(){return this.__iterator(M)},map:function(e,t){return vn(this,Xt(this,e,t))},reduce:function(e,t,n){var r,o;return Ve(this.size),arguments.length<2?o=!0:r=t,this.__iterate((function(t,a,i){o?(o=!1,r=t):r=e.call(n,r,t,a,i)})),r},reduceRight:function(e,t,n){var r=this.toKeyedSeq().reverse();return r.reduce.apply(r,arguments)},reverse:function(){return vn(this,Qt(this,!0))},slice:function(e,t){return vn(this,rn(this,e,t,!0))},some:function(e,t){return!this.every(tr(e),t)},sort:function(e){return vn(this,pn(this,e))},values:function(){return this.__iterator(P)},butLast:function(){return this.slice(0,-1)},isEmpty:function(){return void 0!==this.size?0===this.size:!this.some((function(){return!0}))},count:function(e,t){return A(e?this.toSeq().filter(e,t):this)},countBy:function(e,t){return tn(this,e,t)},equals:function(e){return ye(this,e)},entrySeq:function(){var e=this;if(e._cache)return new te(e._cache);var t=e.toSeq().map(er).toIndexedSeq();return t.fromEntrySeq=function(){return e.toSeq()},t},filterNot:function(e,t){return this.filter(tr(e),t)},findEntry:function(e,t,n){var r=n;return this.__iterate((function(n,o,a){if(e.call(t,n,o,a))return r=[o,n],!1})),r},findKey:function(e,t){var n=this.findEntry(e,t);return n&&n[0]},findLast:function(e,t,n){return this.toKeyedSeq().reverse().find(e,t,n)},findLastEntry:function(e,t,n){return this.toKeyedSeq().reverse().findEntry(e,t,n)},findLastKey:function(e,t){return this.toKeyedSeq().reverse().findKey(e,t)},first:function(){return this.find(O)},flatMap:function(e,t){return vn(this,cn(this,e,t))},flatten:function(e){return vn(this,un(this,e,!0))},fromEntrySeq:function(){return new Gt(this)},get:function(e,t){return this.find((function(t,n){return ge(n,e)}),void 0,t)},getIn:function(e,t){for(var n,r=this,o=xn(e);!(n=o.next()).done;){var a=n.value;if((r=r&&r.get?r.get(a,b):b)===b)return t}return r},groupBy:function(e,t){return nn(this,e,t)},has:function(e){return this.get(e,b)!==b},hasIn:function(e){return this.getIn(e,b)!==b},isSubset:function(e){return e="function"==typeof e.includes?e:n(e),this.every((function(t){return e.includes(t)}))},isSuperset:function(e){return(e="function"==typeof e.isSubset?e:n(e)).isSubset(this)},keyOf:function(e){return this.findKey((function(t){return ge(t,e)}))},keySeq:function(){return this.toSeq().map(Qn).toIndexedSeq()},last:function(){return this.toSeq().reverse().first()},lastKeyOf:function(e){return this.toKeyedSeq().reverse().keyOf(e)},max:function(e){return fn(this,e)},maxBy:function(e,t){return fn(this,t,e)},min:function(e){return fn(this,e?nr(e):ar)},minBy:function(e,t){return fn(this,t?nr(t):ar,e)},rest:function(){return this.slice(1)},skip:function(e){return this.slice(Math.max(0,e))},skipLast:function(e){return vn(this,this.toSeq().reverse().skip(e).reverse())},skipWhile:function(e,t){return vn(this,an(this,e,t,!0))},skipUntil:function(e,t){return this.skipWhile(tr(e),t)},sortBy:function(e,t){return vn(this,pn(this,t,e))},take:function(e){return this.slice(0,Math.max(0,e))},takeLast:function(e){return vn(this,this.toSeq().reverse().take(e).reverse())},takeWhile:function(e,t){return vn(this,on(this,e,t))},takeUntil:function(e,t){return this.takeWhile(tr(e),t)},valueSeq:function(){return this.toIndexedSeq()},hashCode:function(){return this.__hash||(this.__hash=ir(this))}});var Zn=n.prototype;Zn[p]=!0,Zn[B]=Zn.values,Zn.__toJS=Zn.toArray,Zn.__toStringMapper=rr,Zn.inspect=Zn.toSource=function(){return this.toString()},Zn.chain=Zn.flatMap,Zn.contains=Zn.includes,Gn(r,{flip:function(){return vn(this,Zt(this))},mapEntries:function(e,t){var n=this,r=0;return vn(this,this.toSeq().map((function(o,a){return e.call(t,[a,o],r++,n)})).fromEntrySeq())},mapKeys:function(e,t){var n=this;return vn(this,this.toSeq().flip().map((function(r,o){return e.call(t,r,o,n)})).flip())}});var Xn=r.prototype;function Qn(e,t){return t}function er(e,t){return[t,e]}function tr(e){return function(){return!e.apply(this,arguments)}}function nr(e){return function(){return-e.apply(this,arguments)}}function rr(e){return"string"==typeof e?JSON.stringify(e):String(e)}function or(){return S(arguments)}function ar(e,t){return et?-1:0}function ir(e){if(e.size===1/0)return 0;var t=l(e),n=s(e),r=t?1:0;return sr(e.__iterate(n?t?function(e,t){r=31*r+ur(Oe(e),Oe(t))|0}:function(e,t){r=r+ur(Oe(e),Oe(t))|0}:t?function(e){r=31*r+Oe(e)|0}:function(e){r=r+Oe(e)|0}),r)}function sr(e,t){return t=Ae(t,3432918353),t=Ae(t<<15|t>>>-15,461845907),t=Ae(t<<13|t>>>-13,5),t=Ae((t=(t+3864292196|0)^e)^t>>>16,2246822507),t=ke((t=Ae(t^t>>>13,3266489909))^t>>>16)}function ur(e,t){return e^t+2654435769+(e<<6)+(e>>2)|0}return Xn[f]=!0,Xn[B]=Zn.entries,Xn.__toJS=Zn.toObject,Xn.__toStringMapper=function(e,t){return JSON.stringify(t)+": "+rr(e)},Gn(o,{toKeyedSeq:function(){return new $t(this,!1)},filter:function(e,t){return vn(this,en(this,e,t,!1))},findIndex:function(e,t){var n=this.findEntry(e,t);return n?n[0]:-1},indexOf:function(e){var t=this.keyOf(e);return void 0===t?-1:t},lastIndexOf:function(e){var t=this.lastKeyOf(e);return void 0===t?-1:t},reverse:function(){return vn(this,Qt(this,!1))},slice:function(e,t){return vn(this,rn(this,e,t,!1))},splice:function(e,t){var n=arguments.length;if(t=Math.max(0|t,0),0===n||2===n&&!t)return this;e=T(e,e<0?this.count():this.size);var r=this.slice(0,e);return vn(this,1===n?r:r.concat(S(arguments,2),this.slice(e+t)))},findLastIndex:function(e,t){var n=this.findLastEntry(e,t);return n?n[0]:-1},first:function(){return this.get(0)},flatten:function(e){return vn(this,un(this,e,!1))},get:function(e,t){return(e=k(this,e))<0||this.size===1/0||void 0!==this.size&&e>this.size?t:this.find((function(t,n){return n===e}),void 0,t)},has:function(e){return(e=k(this,e))>=0&&(void 0!==this.size?this.size===1/0||e1)try{return decodeURIComponent(t[1])}catch(e){console.error(e)}return null}function Te(e){return t=e.replace(/\.[^./]*$/,""),$()(H()(t));var t}var Ie=function(e,t){if(e>t)return"Value must be less than ".concat(t)},Ne=function(e,t){if(et)return T()(n="Value must be no longer than ".concat(t," character")).call(n,1!==t?"s":"")},qe=function(e,t){var n;if(e.length2&&void 0!==arguments[2]?arguments[2]:{},r=n.isOAS3,o=void 0!==r&&r,a=n.bypassRequiredCheck,i=void 0!==a&&a,s=[],u=e.get("required"),c=Object(ue.a)(e,{isOAS3:o}),l=c.schema,p=c.parameterContentMediaType;if(!l)return s;var f=l.get("required"),h=l.get("maximum"),d=l.get("minimum"),v=l.get("type"),g=l.get("format"),y=l.get("maxLength"),b=l.get("minLength"),_=l.get("pattern");if(v&&(u||f||t)){var w="string"===v&&t,x="array"===v&&B()(t)&&t.length,E="array"===v&&z.a.List.isList(t)&&t.count(),C="array"===v&&"string"==typeof t&&t,S="file"===v&&t instanceof ae.a.File,A="boolean"===v&&(t||!1===t),k="number"===v&&(t||0===t),j="integer"===v&&(t||0===t),T="object"===v&&"object"===U()(t)&&null!==t,I="object"===v&&"string"==typeof t&&t,N=[w,x,E,C,S,A,k,j,T,I],M=m()(N).call(N,(function(e){return!!e}));if((u||f)&&!M&&!i)return s.push("Required field is not provided"),s;if("object"===v&&"string"==typeof t&&(null===p||"application/json"===p))try{JSON.parse(t)}catch(e){return s.push("Parameter string value must be valid JSON"),s}if(_){var P=ze(t,_);P&&s.push(P)}if(y||0===y){var R=Ue(t,y);R&&s.push(R)}if(b){var D=qe(t,b);D&&s.push(D)}if(h||0===h){var L=Ie(t,h);L&&s.push(L)}if(d||0===d){var F=Ne(t,d);F&&s.push(F)}if("string"===v){var q;if(!(q="date-time"===g?Be(t):"uuid"===g?Fe(t):Le(t)))return s;s.push(q)}else if("boolean"===v){var V=De(t);if(!V)return s;s.push(V)}else if("number"===v){var W=Me(t);if(!W)return s;s.push(W)}else if("integer"===v){var H=Pe(t);if(!H)return s;s.push(H)}else if("array"===v){var J;if(!E||!t.count())return s;J=l.getIn(["items","type"]),O()(t).call(t,(function(e,t){var n;"number"===J?n=Me(e):"integer"===J?n=Pe(e):"string"===J&&(n=Le(e)),n&&s.push({index:t,error:n})}))}else if("file"===v){var $=Re(t);if(!$)return s;s.push($)}}return s},We=function(e,t,n){if(e&&(!e.xml||!e.xml.name)){if(e.xml=e.xml||{},!e.$$ref)return e.type||e.items||e.properties||e.additionalProperties?'\n\x3c!-- XML example cannot be generated; root element name is undefined --\x3e':null;var r=e.$$ref.match(/\S*\/(\S+)$/);e.xml.name=r[1]}return Object(oe.memoizedCreateXMLExample)(e,t,n)},He=[{when:/json/,shouldStringifyTypes:["string"]}],Je=["object"],$e=function(e,t,n,r){var o=Object(oe.memoizedSampleFromSchema)(e,t,r),a=U()(o),i=x()(He).call(He,(function(e,t){var r;return t.when.test(n)?T()(r=[]).call(r,d()(e),d()(t.shouldStringifyTypes)):e}),Je);return Q()(i,(function(e){return e===a}))?f()(o,null,2):o},Ke=function(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"",n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{},r=arguments.length>3&&void 0!==arguments[3]?arguments[3]:void 0;return e&&we(e.toJS)&&(e=e.toJS()),r&&we(r.toJS)&&(r=r.toJS()),/xml/.test(t)?We(e,n,r):$e(e,n,t,r)},Ye=function(){var e={},t=ae.a.location.search;if(!t)return{};if(""!=t){var n=t.substr(1).split("&");for(var r in n)n.hasOwnProperty(r)&&(r=n[r].split("="),e[decodeURIComponent(r[0])]=r[1]&&decodeURIComponent(r[1])||"")}return e},Ge=function(t){return(t instanceof e?t:e.from(t.toString(),"utf-8")).toString("base64")},Ze={operationsSorter:{alpha:function(e,t){return e.get("path").localeCompare(t.get("path"))},method:function(e,t){return e.get("method").localeCompare(t.get("method"))}},tagsSorter:{alpha:function(e,t){return e.localeCompare(t)}}},Xe=function(e){var t=[];for(var n in e){var r=e[n];void 0!==r&&""!==r&&t.push([n,"=",encodeURIComponent(r).replace(/%20/g,"+")].join(""))}return t.join("&")},Qe=function(e,t,n){return!!Z()(n,(function(n){return te()(e[n],t[n])}))};function et(e){return"string"!=typeof e||""===e?"":Object(V.sanitizeUrl)(e)}function tt(e){return!(!e||l()(e).call(e,"localhost")>=0||l()(e).call(e,"127.0.0.1")>=0||"none"===e)}function nt(e){if(!z.a.OrderedMap.isOrderedMap(e))return null;if(!e.size)return null;var t=u()(e).call(e,(function(e,t){return i()(t).call(t,"2")&&C()(e.get("content")||{}).length>0})),n=e.get("default")||z.a.OrderedMap(),r=(n.get("content")||z.a.OrderedMap()).keySeq().toJS().length?n:null;return t||r}var rt=function(e){return"string"==typeof e||e instanceof String?o()(e).call(e).replace(/\s/g,"%20"):""},ot=function(e){return se()(rt(e).replace(/%20/g,"_"))},at=function(e){return A()(e).call(e,(function(e,t){return/^x-/.test(t)}))},it=function(e){return A()(e).call(e,(function(e,t){return/^pattern|maxLength|minLength|maximum|minimum/.test(t)}))};function st(e,t){var n,r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:function(){return!0};if("object"!==U()(e)||B()(e)||null===e||!t)return e;var o=_()({},e);return O()(n=C()(o)).call(n,(function(e){e===t&&r(o[e],e)?delete o[e]:o[e]=st(o[e],t,r)})),o}function ut(e){if("string"==typeof e)return e;if(e&&e.toJS&&(e=e.toJS()),"object"===U()(e)&&null!==e)try{return f()(e,null,2)}catch(t){return String(e)}return null==e?"":e.toString()}function ct(e){return"number"==typeof e?e.toString():e}function lt(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=t.returnAll,r=void 0!==n&&n,o=t.allowHashes,a=void 0===o||o;if(!z.a.Map.isMap(e))throw new Error("paramToIdentifier: received a non-Im.Map parameter as input");var i,s,u,c=e.get("name"),l=e.get("in"),p=[];e&&e.hashCode&&l&&c&&a&&p.push(T()(i=T()(s="".concat(l,".")).call(s,c,".hash-")).call(i,e.hashCode()));l&&c&&p.push(T()(u="".concat(l,".")).call(u,c));return p.push(c),r?p:p[0]||""}function pt(e,t){var n,r=lt(e,{returnAll:!0});return A()(n=D()(r).call(r,(function(e){return t[e]}))).call(n,(function(e){return void 0!==e}))[0]}function ft(){return dt(le()(32).toString("base64"))}function ht(e){return dt(fe()("sha256").update(e).digest("base64"))}function dt(e){return e.replace(/\+/g,"-").replace(/\//g,"_").replace(/=/g,"")}var vt=function(e){return!e||!(!de(e)||!e.isEmpty())}}).call(this,n(77).Buffer)},function(e,t,n){var r=n(896),o=n(899);e.exports=function(e,t){if("function"!=typeof t&&null!==t)throw new TypeError("Super expression must either be null or a function");e.prototype=r(t&&t.prototype,{constructor:{value:e,writable:!0,configurable:!0}}),t&&o(e,t)}},function(e,t,n){var r=n(462),o=n(206),a=n(910),i=n(911);e.exports=function(e){var t=a();return function(){var n,a=o(e);if(t){var s=o(this).constructor;n=r(a,arguments,s)}else n=a.apply(this,arguments);return i(this,n)}}},function(e,t){e.exports=function(e){if(void 0===e)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return e}},function(e,t,n){e.exports=n(989)()},function(e,t,n){e.exports=n(641)},function(e,t,n){e.exports=n(576)},function(e,t,n){e.exports=n(593)},function(e,t,n){e.exports=n(544)},function(e,t,n){var r=n(398),o=n(663),a=n(182),i=n(401);e.exports=function(e,t){return r(e)||o(e,t)||a(e,t)||i()}},function(e,t,n){var r=n(644),o=n(390),a=n(182),i=n(652);e.exports=function(e){return r(e)||o(e)||a(e)||i()}},function(e,t,n){e.exports=n(402)},function(e,t,n){"use strict";function r(e,t){return e===t}function o(e,t,n){if(null===t||null===n||t.length!==n.length)return!1;for(var r=t.length,o=0;o1?t-1:0),r=1;r1&&void 0!==arguments[1]?arguments[1]:r,n=null,a=null;return function(){return o(t,n,arguments)||(a=e.apply(null,arguments)),n=arguments,a}}))},function(e,t,n){var r=n(546),o=n(179);function a(t){return e.exports=a="function"==typeof o&&"symbol"==typeof r?function(e){return typeof e}:function(e){return e&&"function"==typeof o&&e.constructor===o&&e!==o.prototype?"symbol":typeof e},a(t)}e.exports=a},function(e,t,n){e.exports=n(600)},function(e,t,n){e.exports=n(588)},function(e,t,n){e.exports=n(597)},function(e,t,n){"use strict";var r=n(41),o=n(106).f,a=n(354),i=n(34),s=n(109),u=n(70),c=n(52),l=function(e){var t=function(t,n,r){if(this instanceof e){switch(arguments.length){case 0:return new e;case 1:return new e(t);case 2:return new e(t,n)}return new e(t,n,r)}return e.apply(this,arguments)};return t.prototype=e.prototype,t};e.exports=function(e,t){var n,p,f,h,d,v,m,g,y=e.target,b=e.global,_=e.stat,w=e.proto,x=b?r:_?r[y]:(r[y]||{}).prototype,E=b?i:i[y]||(i[y]={}),C=E.prototype;for(f in t)n=!a(b?f:y+(_?".":"#")+f,e.forced)&&x&&c(x,f),d=E[f],n&&(v=e.noTargetGet?(g=o(x,f))&&g.value:x[f]),h=n&&v?v:t[f],n&&typeof d==typeof h||(m=e.bind&&n?s(h,r):e.wrap&&n?l(h):w&&"function"==typeof h?s(Function.call,h):h,(e.sham||h&&h.sham||d&&d.sham)&&u(m,"sham",!0),E[f]=m,w&&(c(i,p=y+"Prototype")||u(i,p,{}),i[p][f]=h,e.real&&C&&!C[f]&&u(C,f,h)))}},function(e,t,n){var r=n(240),o=n(833),a=n(837),i=n(842),s=n(443),u=n(847),c=n(444),l=n(445),p=n(3);function f(e,t){var n=l(e);if(c){var r=c(e);t&&(r=u(r).call(r,(function(t){return s(e,t).enumerable}))),n.push.apply(n,r)}return n}e.exports=function(e){for(var t=1;t>",a={listOf:function(e){return c(e,"List",r.List.isList)},mapOf:function(e,t){return p(e,t,"Map",r.Map.isMap)},orderedMapOf:function(e,t){return p(e,t,"OrderedMap",r.OrderedMap.isOrderedMap)},setOf:function(e){return c(e,"Set",r.Set.isSet)},orderedSetOf:function(e){return c(e,"OrderedSet",r.OrderedSet.isOrderedSet)},stackOf:function(e){return c(e,"Stack",r.Stack.isStack)},iterableOf:function(e){return c(e,"Iterable",r.Iterable.isIterable)},recordOf:function(e){return s((function(t,n,o,a,s){for(var u=arguments.length,c=Array(u>5?u-5:0),l=5;l6?u-6:0),l=6;l5?c-5:0),p=5;p5?i-5:0),u=5;u key("+l[p]+")"].concat(s));if(h instanceof Error)return h}}))}function p(e,t,n,r){return s((function(){for(var o=arguments.length,a=Array(o),i=0;i5?c-5:0),p=5;p4)}function l(e){var t=e.get("swagger");return"string"==typeof t&&i()(t).call(t,"2.0")}function p(e){return function(t,n){return function(r){return n&&n.specSelectors&&n.specSelectors.specJson?c(n.specSelectors.specJson())?u.a.createElement(e,o()({},r,n,{Ori:t})):u.a.createElement(t,r):(console.warn("OAS3 wrapper: couldn't get spec"),null)}}}},function(e,t,n){var r=n(41),o=n(228),a=n(52),i=n(177),s=n(229),u=n(359),c=o("wks"),l=r.Symbol,p=u?l:l&&l.withoutSetter||i;e.exports=function(e){return a(c,e)||(s&&a(l,e)?c[e]=l[e]:c[e]=p("Symbol."+e)),c[e]}},function(e,t,n){"use strict";var r=Object.getOwnPropertySymbols,o=Object.prototype.hasOwnProperty,a=Object.prototype.propertyIsEnumerable;function i(e){if(null==e)throw new TypeError("Object.assign cannot be called with null or undefined");return Object(e)}e.exports=function(){try{if(!Object.assign)return!1;var e=new String("abc");if(e[5]="de","5"===Object.getOwnPropertyNames(e)[0])return!1;for(var t={},n=0;n<10;n++)t["_"+String.fromCharCode(n)]=n;if("0123456789"!==Object.getOwnPropertyNames(t).map((function(e){return t[e]})).join(""))return!1;var r={};return"abcdefghijklmnopqrst".split("").forEach((function(e){r[e]=e})),"abcdefghijklmnopqrst"===Object.keys(Object.assign({},r)).join("")}catch(e){return!1}}()?Object.assign:function(e,t){for(var n,s,u=i(e),c=1;c0){var o=P()(n).call(n,(function(e){return console.error(e),e.line=e.fullPath?g(y,e.fullPath):null,e.path=e.fullPath?e.fullPath.join("."):null,e.level="error",e.type="thrown",e.source="resolver",N()(e,"message",{enumerable:!0,value:e.message}),e}));a.newThrownErrBatch(o)}return r.updateResolved(t)}))}},Ee=[],Ce=Y()(T()(C.a.mark((function e(){var t,n,r,o,a,i,s,u,c,l,p,f,h,d,v,m,g;return C.a.wrap((function(e){for(;;)switch(e.prev=e.next){case 0:if(t=Ee.system){e.next=4;break}return console.error("debResolveSubtrees: don't have a system to operate on, aborting."),e.abrupt("return");case 4:if(n=t.errActions,r=t.errSelectors,o=t.fn,a=o.resolveSubtree,i=o.AST,s=void 0===i?{}:i,u=t.specSelectors,c=t.specActions,a){e.next=8;break}return console.error("Error: Swagger-Client did not provide a `resolveSubtree` method, doing nothing."),e.abrupt("return");case 8:return l=s.getLineNumberForPath?s.getLineNumberForPath:function(){},p=u.specStr(),f=t.getConfigs(),h=f.modelPropertyMacro,d=f.parameterMacro,v=f.requestInterceptor,m=f.responseInterceptor,e.prev=11,e.next=14,O()(Ee).call(Ee,function(){var e=T()(C.a.mark((function e(t,o){var i,s,c,f,g,y,b;return C.a.wrap((function(e){for(;;)switch(e.prev=e.next){case 0:return e.next=2,t;case 2:return i=e.sent,s=i.resultMap,c=i.specWithCurrentSubtrees,e.next=7,a(c,o,{baseDoc:u.url(),modelPropertyMacro:h,parameterMacro:d,requestInterceptor:v,responseInterceptor:m});case 7:return f=e.sent,g=f.errors,y=f.spec,r.allErrors().size&&n.clearBy((function(e){var t;return"thrown"!==e.get("type")||"resolver"!==e.get("source")||!A()(t=e.get("fullPath")).call(t,(function(e,t){return e===o[t]||void 0===o[t]}))})),D()(g)&&g.length>0&&(b=P()(g).call(g,(function(e){return e.line=e.fullPath?l(p,e.fullPath):null,e.path=e.fullPath?e.fullPath.join("."):null,e.level="error",e.type="thrown",e.source="resolver",N()(e,"message",{enumerable:!0,value:e.message}),e})),n.newThrownErrBatch(b)),Z()(s,o,y),Z()(c,o,y),e.abrupt("return",{resultMap:s,specWithCurrentSubtrees:c});case 15:case"end":return e.stop()}}),e)})));return function(t,n){return e.apply(this,arguments)}}(),x.a.resolve({resultMap:(u.specResolvedSubtree([])||Object(q.Map)()).toJS(),specWithCurrentSubtrees:u.specJson().toJS()}));case 14:g=e.sent,delete Ee.system,Ee=[],e.next=22;break;case 19:e.prev=19,e.t0=e.catch(11),console.error(e.t0);case 22:c.updateResolvedSubtree([],g.resultMap);case 23:case"end":return e.stop()}}),e,null,[[11,19]])}))),35),Se=function(e){return function(t){var n;_()(n=P()(Ee).call(Ee,(function(e){return e.join("@@")}))).call(n,e.join("@@"))>-1||(Ee.push(e),Ee.system=t,Ce())}};function Ae(e,t,n,r,o){return{type:ne,payload:{path:e,value:r,paramName:t,paramIn:n,isXml:o}}}function ke(e,t,n,r){return{type:ne,payload:{path:e,param:t,value:n,isXml:r}}}var Oe=function(e,t){return{type:de,payload:{path:e,value:t}}},je=function(){return{type:de,payload:{path:[],value:Object(q.Map)()}}},Te=function(e,t){return{type:oe,payload:{pathMethod:e,isOAS3:t}}},Ie=function(e,t,n,r){return{type:re,payload:{pathMethod:e,paramName:t,paramIn:n,includeEmptyValue:r}}};function Ne(e){return{type:pe,payload:{pathMethod:e}}}function Me(e,t){return{type:fe,payload:{path:e,value:t,key:"consumes_value"}}}function Pe(e,t){return{type:fe,payload:{path:e,value:t,key:"produces_value"}}}var Re=function(e,t,n){return{payload:{path:e,method:t,res:n},type:ae}},De=function(e,t,n){return{payload:{path:e,method:t,req:n},type:ie}},Le=function(e,t,n){return{payload:{path:e,method:t,req:n},type:se}},Be=function(e){return{payload:e,type:ue}},Fe=function(e){return function(t){var n,r,o=t.fn,a=t.specActions,i=t.specSelectors,s=t.getConfigs,c=t.oas3Selectors,p=e.pathName,h=e.method,v=e.operation,g=s(),b=g.requestInterceptor,_=g.responseInterceptor,w=v.toJS();v&&v.get("parameters")&&y()(n=m()(r=v.get("parameters")).call(r,(function(e){return e&&!0===e.get("allowEmptyValue")}))).call(n,(function(t){if(i.parameterInclusionSettingFor([p,h],t.get("name"),t.get("in"))){e.parameters=e.parameters||{};var n=Object(X.C)(t,e.parameters);(!n||n&&0===n.size)&&(e.parameters[t.get("name")]="")}}));if(e.contextUrl=V()(i.url()).toString(),w&&w.operationId?e.operationId=w.operationId:w&&p&&h&&(e.operationId=o.opId(w,p,h)),i.isOAS3()){var x,E=d()(x="".concat(p,":")).call(x,h);e.server=c.selectedServer(E)||c.selectedServer();var S=c.serverVariables({server:e.server,namespace:E}).toJS(),A=c.serverVariables({server:e.server}).toJS();e.serverVariables=f()(S).length?S:A,e.requestContentType=c.requestContentType(p,h),e.responseContentType=c.responseContentType(p,h)||"*/*";var k=c.requestBodyValue(p,h),O=c.requestBodyInclusionSetting(p,h);if(Object(X.t)(k))e.requestBody=JSON.parse(k);else if(k&&k.toJS){var j;e.requestBody=m()(j=P()(k).call(k,(function(e){return q.Map.isMap(e)?e.get("value"):e}))).call(j,(function(e,t){return(D()(e)?0!==e.length:!Object(X.q)(e))||O.get(t)})).toJS()}else e.requestBody=k}var I=l()({},e);I=o.buildRequest(I),a.setRequest(e.pathName,e.method,I);var N=function(){var t=T()(C.a.mark((function t(n){var r,o;return C.a.wrap((function(t){for(;;)switch(t.prev=t.next){case 0:return t.next=2,b.apply(undefined,[n]);case 2:return r=t.sent,o=l()({},r),a.setMutatedRequest(e.pathName,e.method,o),t.abrupt("return",r);case 6:case"end":return t.stop()}}),t)})));return function(e){return t.apply(this,arguments)}}();e.requestInterceptor=N,e.responseInterceptor=_;var M=u()();return o.execute(e).then((function(t){t.duration=u()()-M,a.setResponse(e.pathName,e.method,t)})).catch((function(t){console.error(t),a.setResponse(e.pathName,e.method,{error:!0,err:H()(t)})}))}},Ue=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{},t=e.path,n=e.method,r=i()(e,["path","method"]);return function(e){var a=e.fn.fetch,i=e.specSelectors,s=e.specActions,u=i.specJsonWithResolvedSubtrees().toJS(),c=i.operationScheme(t,n),l=i.contentTypeValues([t,n]).toJS(),p=l.requestContentType,f=l.responseContentType,h=/xml/i.test(p),d=i.parameterValues([t,n],h).toJS();return s.executeRequest(o()(o()({},r),{},{fetch:a,spec:u,pathName:t,method:n,parameters:d,requestContentType:p,scheme:c,responseContentType:f}))}};function qe(e,t){return{type:ce,payload:{path:e,method:t}}}function ze(e,t){return{type:le,payload:{path:e,method:t}}}function Ve(e,t,n){return{type:ve,payload:{scheme:e,path:t,method:n}}}},function(e,t,n){var r=n(36);e.exports=!r((function(){return 7!=Object.defineProperty({},1,{get:function(){return 7}})[1]}))},function(e,t,n){var r=n(34),o=n(52),a=n(227),i=n(63).f;e.exports=function(e){var t=r.Symbol||(r.Symbol={});o(t,e)||i(t,e,{value:a.f(e)})}},function(e,t,n){"use strict";var r=n(163),o=["kind","resolve","construct","instanceOf","predicate","represent","defaultStyle","styleAliases"],a=["scalar","sequence","mapping"];e.exports=function(e,t){var n,i;if(t=t||{},Object.keys(t).forEach((function(t){if(-1===o.indexOf(t))throw new r('Unknown option "'+t+'" is met in definition of "'+e+'" YAML type.')})),this.tag=e,this.kind=t.kind||null,this.resolve=t.resolve||function(){return!0},this.construct=t.construct||function(e){return e},this.instanceOf=t.instanceOf||null,this.predicate=t.predicate||null,this.represent=t.represent||null,this.defaultStyle=t.defaultStyle||null,this.styleAliases=(n=t.styleAliases||null,i={},null!==n&&Object.keys(n).forEach((function(e){n[e].forEach((function(t){i[String(t)]=e}))})),i),-1===a.indexOf(this.kind))throw new r('Unknown kind "'+this.kind+'" is specified for "'+e+'" YAML type.')}},function(e,t,n){var r=n(399),o=n(241),a=n(673),i=n(179),s=n(182);e.exports=function(e,t){var n;if(void 0===i||null==a(e)){if(o(e)||(n=s(e))||t&&e&&"number"==typeof e.length){n&&(e=n);var u=0,c=function(){};return{s:c,n:function(){return u>=e.length?{done:!0}:{done:!1,value:e[u++]}},e:function(e){throw e},f:c}}throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.")}var l,p=!0,f=!1;return{s:function(){n=r(e)},n:function(){var e=n.next();return p=e.done,e},e:function(e){f=!0,l=e},f:function(){try{p||null==n.return||n.return()}finally{if(f)throw l}}}}},function(e,t){var n={}.hasOwnProperty;e.exports=function(e,t){return n.call(e,t)}},function(e,t){var n=Array.isArray;e.exports=n},function(e,t){var n;n=function(){return this}();try{n=n||new Function("return this")()}catch(e){"object"==typeof window&&(n=window)}e.exports=n},function(e,t,n){var r=n(45);e.exports=function(e){if(!r(e))throw TypeError(String(e)+" is not an object");return e}},function(e,t,n){var r=n(446),o=n(444),a=n(853);e.exports=function(e,t){if(null==e)return{};var n,i,s=a(e,t);if(o){var u=o(e);for(i=0;i=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(s[n]=e[n])}return s}},function(e,t,n){"use strict";var r=!("undefined"==typeof window||!window.document||!window.document.createElement),o={canUseDOM:r,canUseWorkers:"undefined"!=typeof Worker,canUseEventListeners:r&&!(!window.addEventListener&&!window.attachEvent),canUseViewport:r&&!!window.screen,isInWorker:!r};e.exports=o},function(e,t,n){e.exports=n(637)},function(e,t,n){"use strict";n.r(t),n.d(t,"UPDATE_SELECTED_SERVER",(function(){return r})),n.d(t,"UPDATE_REQUEST_BODY_VALUE",(function(){return o})),n.d(t,"UPDATE_REQUEST_BODY_INCLUSION",(function(){return a})),n.d(t,"UPDATE_ACTIVE_EXAMPLES_MEMBER",(function(){return i})),n.d(t,"UPDATE_REQUEST_CONTENT_TYPE",(function(){return s})),n.d(t,"UPDATE_RESPONSE_CONTENT_TYPE",(function(){return u})),n.d(t,"UPDATE_SERVER_VARIABLE_VALUE",(function(){return c})),n.d(t,"SET_REQUEST_BODY_VALIDATE_ERROR",(function(){return l})),n.d(t,"CLEAR_REQUEST_BODY_VALIDATE_ERROR",(function(){return p})),n.d(t,"CLEAR_REQUEST_BODY_VALUE",(function(){return f})),n.d(t,"setSelectedServer",(function(){return h})),n.d(t,"setRequestBodyValue",(function(){return d})),n.d(t,"setRequestBodyInclusion",(function(){return v})),n.d(t,"setActiveExamplesMember",(function(){return m})),n.d(t,"setRequestContentType",(function(){return g})),n.d(t,"setResponseContentType",(function(){return y})),n.d(t,"setServerVariableValue",(function(){return b})),n.d(t,"setRequestBodyValidateError",(function(){return _})),n.d(t,"clearRequestBodyValidateError",(function(){return w})),n.d(t,"initRequestBodyValidateError",(function(){return x})),n.d(t,"clearRequestBodyValue",(function(){return E}));var r="oas3_set_servers",o="oas3_set_request_body_value",a="oas3_set_request_body_inclusion",i="oas3_set_active_examples_member",s="oas3_set_request_content_type",u="oas3_set_response_content_type",c="oas3_set_server_variable_value",l="oas3_set_request_body_validate_error",p="oas3_clear_request_body_validate_error",f="oas3_clear_request_body_value";function h(e,t){return{type:r,payload:{selectedServerUrl:e,namespace:t}}}function d(e){var t=e.value,n=e.pathMethod;return{type:o,payload:{value:t,pathMethod:n}}}function v(e){var t=e.value,n=e.pathMethod,r=e.name;return{type:a,payload:{value:t,pathMethod:n,name:r}}}function m(e){var t=e.name,n=e.pathMethod,r=e.contextType,o=e.contextName;return{type:i,payload:{name:t,pathMethod:n,contextType:r,contextName:o}}}function g(e){var t=e.value,n=e.pathMethod;return{type:s,payload:{value:t,pathMethod:n}}}function y(e){var t=e.value,n=e.path,r=e.method;return{type:u,payload:{value:t,path:n,method:r}}}function b(e){var t=e.server,n=e.namespace,r=e.key,o=e.val;return{type:c,payload:{server:t,namespace:n,key:r,val:o}}}var _=function(e){var t=e.path,n=e.method,r=e.validationErrors;return{type:l,payload:{path:t,method:n,validationErrors:r}}},w=function(e){var t=e.path,n=e.method;return{type:p,payload:{path:t,method:n}}},x=function(e){var t=e.pathMethod;return{type:p,payload:{path:t[0],method:t[1]}}},E=function(e){var t=e.pathMethod;return{type:f,payload:{pathMethod:t}}}},function(e,t){e.exports=function(e){var t=typeof e;return null!=e&&("object"==t||"function"==t)}},function(e,t,n){"use strict";n.d(t,"b",(function(){return b})),n.d(t,"e",(function(){return _})),n.d(t,"c",(function(){return x})),n.d(t,"a",(function(){return E})),n.d(t,"d",(function(){return C}));var r=n(51),o=n.n(r),a=n(18),i=n.n(a),s=n(35),u=n.n(s),c=n(2),l=n.n(c),p=n(20),f=n.n(p),h=n(60),d=n.n(h),v=n(349),m=n.n(v),g=function(e){return String.prototype.toLowerCase.call(e)},y=function(e){return e.replace(/[^\w]/gi,"_")};function b(e){var t=e.openapi;return!!t&&m()(t,"3")}function _(e,t){var n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:"",r=arguments.length>3&&void 0!==arguments[3]?arguments[3]:{},o=r.v2OperationIdCompatibilityMode;if(!e||"object"!==f()(e))return null;var a=(e.operationId||"").replace(/\s/g,"");return a.length?y(e.operationId):w(t,n,{v2OperationIdCompatibilityMode:o})}function w(e,t){var n,r=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{},o=r.v2OperationIdCompatibilityMode;if(o){var a,i,s=l()(a="".concat(t.toLowerCase(),"_")).call(a,e).replace(/[\s!@#$%^&*()_+=[{\]};:<>|./?,\\'""-]/g,"_");return(s=s||l()(i="".concat(e.substring(1),"_")).call(i,t)).replace(/((_){2,})/g,"_").replace(/^(_)*/g,"").replace(/([_])*$/g,"")}return l()(n="".concat(g(t))).call(n,y(e))}function x(e,t){var n;return l()(n="".concat(g(t),"-")).call(n,e)}function E(e,t){return e&&e.paths?function(e,t){return function(e,t,n){if(!e||"object"!==f()(e)||!e.paths||"object"!==f()(e.paths))return null;var r=e.paths;for(var o in r)for(var a in r[o])if("PARAMETERS"!==a.toUpperCase()){var i=r[o][a];if(i&&"object"===f()(i)){var s={spec:e,pathName:o,method:a.toUpperCase(),operation:i},u=t(s);if(n&&u)return s}}return}(e,t,!0)||null}(e,(function(e){var n,r=e.pathName,o=e.method,a=e.operation;if(!a||"object"!==f()(a))return!1;var i=a.operationId,s=_(a,r,o),c=x(r,o);return u()(n=[s,c,i]).call(n,(function(e){return e&&e===t}))})):null}function C(e){var t=e.spec,n=t.paths,r={};if(!n||t.$$normalized)return e;for(var a in n){var s=n[a];if(d()(s)){var c=s.parameters,p=function(e){var n=s[e];if(!d()(n))return"continue";var p=_(n,a,e);if(p){r[p]?r[p].push(n):r[p]=[n];var f=r[p];if(f.length>1)i()(f).call(f,(function(e,t){var n;e.__originalOperationId=e.__originalOperationId||e.operationId,e.operationId=l()(n="".concat(p)).call(n,t+1)}));else if(void 0!==n.operationId){var h=f[0];h.__originalOperationId=h.__originalOperationId||n.operationId,h.operationId=p}}if("parameters"!==e){var v=[],m={};for(var g in t)"produces"!==g&&"consumes"!==g&&"security"!==g||(m[g]=t[g],v.push(m));if(c&&(m.parameters=c,v.push(m)),v.length){var y,b=o()(v);try{for(b.s();!(y=b.n()).done;){var w=y.value;for(var x in w)if(n[x]){if("parameters"===x){var E,C=o()(w[x]);try{var S=function(){var e,t=E.value;u()(e=n[x]).call(e,(function(e){return e.name&&e.name===t.name||e.$ref&&e.$ref===t.$ref||e.$$ref&&e.$$ref===t.$$ref||e===t}))||n[x].push(t)};for(C.s();!(E=C.n()).done;)S()}catch(e){C.e(e)}finally{C.f()}}}else n[x]=w[x]}}catch(e){b.e(e)}finally{b.f()}}}};for(var f in s)p(f)}}return t.$$normalized=!0,e}},function(e,t,n){"use strict";n.r(t),n.d(t,"NEW_THROWN_ERR",(function(){return a})),n.d(t,"NEW_THROWN_ERR_BATCH",(function(){return i})),n.d(t,"NEW_SPEC_ERR",(function(){return s})),n.d(t,"NEW_SPEC_ERR_BATCH",(function(){return u})),n.d(t,"NEW_AUTH_ERR",(function(){return c})),n.d(t,"CLEAR",(function(){return l})),n.d(t,"CLEAR_BY",(function(){return p})),n.d(t,"newThrownErr",(function(){return f})),n.d(t,"newThrownErrBatch",(function(){return h})),n.d(t,"newSpecErr",(function(){return d})),n.d(t,"newSpecErrBatch",(function(){return v})),n.d(t,"newAuthErr",(function(){return m})),n.d(t,"clear",(function(){return g})),n.d(t,"clearBy",(function(){return y}));var r=n(142),o=n.n(r),a="err_new_thrown_err",i="err_new_thrown_err_batch",s="err_new_spec_err",u="err_new_spec_err_batch",c="err_new_auth_err",l="err_clear",p="err_clear_by";function f(e){return{type:a,payload:o()(e)}}function h(e){return{type:i,payload:e}}function d(e){return{type:s,payload:e}}function v(e){return{type:u,payload:e}}function m(e){return{type:c,payload:e}}function g(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};return{type:l,payload:e}}function y(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:function(){return!0};return{type:p,payload:e}}},function(e,t,n){var r=n(48),o=n(353),a=n(55),i=n(176),s=Object.defineProperty;t.f=r?s:function(e,t,n){if(a(e),t=i(t,!0),a(n),o)try{return s(e,t,n)}catch(e){}if("get"in n||"set"in n)throw TypeError("Accessors not supported");return"value"in n&&(e[t]=n.value),e}},function(e,t,n){var r=n(48),o=n(36),a=n(52),i=Object.defineProperty,s={},u=function(e){throw e};e.exports=function(e,t){if(a(s,e))return s[e];t||(t={});var n=[][e],c=!!a(t,"ACCESSORS")&&t.ACCESSORS,l=a(t,0)?t[0]:u,p=a(t,1)?t[1]:void 0;return s[e]=!!n&&!o((function(){if(c&&!r)return!0;var e={length:-1};c?i(e,1,{enumerable:!0,get:u}):e[1]=1,n.call(e,l,p)}))}},function(e,t){"function"==typeof Object.create?e.exports=function(e,t){e.super_=t,e.prototype=Object.create(t.prototype,{constructor:{value:e,enumerable:!1,writable:!0,configurable:!0}})}:e.exports=function(e,t){e.super_=t;var n=function(){};n.prototype=t.prototype,e.prototype=new n,e.prototype.constructor=e}},function(e,t,n){var r=n(77),o=r.Buffer;function a(e,t){for(var n in e)t[n]=e[n]}function i(e,t,n){return o(e,t,n)}o.from&&o.alloc&&o.allocUnsafe&&o.allocUnsafeSlow?e.exports=r:(a(r,t),t.Buffer=i),a(o,i),i.from=function(e,t,n){if("number"==typeof e)throw new TypeError("Argument must not be a number");return o(e,t,n)},i.alloc=function(e,t,n){if("number"!=typeof e)throw new TypeError("Argument must be a number");var r=o(e);return void 0!==t?"string"==typeof n?r.fill(t,n):r.fill(t):r.fill(0),r},i.allocUnsafe=function(e){if("number"!=typeof e)throw new TypeError("Argument must be a number");return o(e)},i.allocUnsafeSlow=function(e){if("number"!=typeof e)throw new TypeError("Argument must be a number");return r.SlowBuffer(e)}},function(e,t,n){var r;!function(){"use strict";var n={}.hasOwnProperty;function o(){for(var e=[],t=0;t=i())throw new RangeError("Attempt to allocate Buffer larger than maximum size: 0x"+i().toString(16)+" bytes");return 0|e}function d(e,t){if(u.isBuffer(e))return e.length;if("undefined"!=typeof ArrayBuffer&&"function"==typeof ArrayBuffer.isView&&(ArrayBuffer.isView(e)||e instanceof ArrayBuffer))return e.byteLength;"string"!=typeof e&&(e=""+e);var n=e.length;if(0===n)return 0;for(var r=!1;;)switch(t){case"ascii":case"latin1":case"binary":return n;case"utf8":case"utf-8":case void 0:return q(e).length;case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return 2*n;case"hex":return n>>>1;case"base64":return z(e).length;default:if(r)return q(e).length;t=(""+t).toLowerCase(),r=!0}}function v(e,t,n){var r=!1;if((void 0===t||t<0)&&(t=0),t>this.length)return"";if((void 0===n||n>this.length)&&(n=this.length),n<=0)return"";if((n>>>=0)<=(t>>>=0))return"";for(e||(e="utf8");;)switch(e){case"hex":return T(this,t,n);case"utf8":case"utf-8":return A(this,t,n);case"ascii":return O(this,t,n);case"latin1":case"binary":return j(this,t,n);case"base64":return S(this,t,n);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return I(this,t,n);default:if(r)throw new TypeError("Unknown encoding: "+e);e=(e+"").toLowerCase(),r=!0}}function m(e,t,n){var r=e[t];e[t]=e[n],e[n]=r}function g(e,t,n,r,o){if(0===e.length)return-1;if("string"==typeof n?(r=n,n=0):n>2147483647?n=2147483647:n<-2147483648&&(n=-2147483648),n=+n,isNaN(n)&&(n=o?0:e.length-1),n<0&&(n=e.length+n),n>=e.length){if(o)return-1;n=e.length-1}else if(n<0){if(!o)return-1;n=0}if("string"==typeof t&&(t=u.from(t,r)),u.isBuffer(t))return 0===t.length?-1:y(e,t,n,r,o);if("number"==typeof t)return t&=255,u.TYPED_ARRAY_SUPPORT&&"function"==typeof Uint8Array.prototype.indexOf?o?Uint8Array.prototype.indexOf.call(e,t,n):Uint8Array.prototype.lastIndexOf.call(e,t,n):y(e,[t],n,r,o);throw new TypeError("val must be string, number or Buffer")}function y(e,t,n,r,o){var a,i=1,s=e.length,u=t.length;if(void 0!==r&&("ucs2"===(r=String(r).toLowerCase())||"ucs-2"===r||"utf16le"===r||"utf-16le"===r)){if(e.length<2||t.length<2)return-1;i=2,s/=2,u/=2,n/=2}function c(e,t){return 1===i?e[t]:e.readUInt16BE(t*i)}if(o){var l=-1;for(a=n;as&&(n=s-u),a=n;a>=0;a--){for(var p=!0,f=0;fo&&(r=o):r=o;var a=t.length;if(a%2!=0)throw new TypeError("Invalid hex string");r>a/2&&(r=a/2);for(var i=0;i>8,o=n%256,a.push(o),a.push(r);return a}(t,e.length-n),e,n,r)}function S(e,t,n){return 0===t&&n===e.length?r.fromByteArray(e):r.fromByteArray(e.slice(t,n))}function A(e,t,n){n=Math.min(e.length,n);for(var r=[],o=t;o239?4:c>223?3:c>191?2:1;if(o+p<=n)switch(p){case 1:c<128&&(l=c);break;case 2:128==(192&(a=e[o+1]))&&(u=(31&c)<<6|63&a)>127&&(l=u);break;case 3:a=e[o+1],i=e[o+2],128==(192&a)&&128==(192&i)&&(u=(15&c)<<12|(63&a)<<6|63&i)>2047&&(u<55296||u>57343)&&(l=u);break;case 4:a=e[o+1],i=e[o+2],s=e[o+3],128==(192&a)&&128==(192&i)&&128==(192&s)&&(u=(15&c)<<18|(63&a)<<12|(63&i)<<6|63&s)>65535&&u<1114112&&(l=u)}null===l?(l=65533,p=1):l>65535&&(l-=65536,r.push(l>>>10&1023|55296),l=56320|1023&l),r.push(l),o+=p}return function(e){var t=e.length;if(t<=k)return String.fromCharCode.apply(String,e);var n="",r=0;for(;r0&&(e=this.toString("hex",0,n).match(/.{2}/g).join(" "),this.length>n&&(e+=" ... ")),""},u.prototype.compare=function(e,t,n,r,o){if(!u.isBuffer(e))throw new TypeError("Argument must be a Buffer");if(void 0===t&&(t=0),void 0===n&&(n=e?e.length:0),void 0===r&&(r=0),void 0===o&&(o=this.length),t<0||n>e.length||r<0||o>this.length)throw new RangeError("out of range index");if(r>=o&&t>=n)return 0;if(r>=o)return-1;if(t>=n)return 1;if(this===e)return 0;for(var a=(o>>>=0)-(r>>>=0),i=(n>>>=0)-(t>>>=0),s=Math.min(a,i),c=this.slice(r,o),l=e.slice(t,n),p=0;po)&&(n=o),e.length>0&&(n<0||t<0)||t>this.length)throw new RangeError("Attempt to write outside buffer bounds");r||(r="utf8");for(var a=!1;;)switch(r){case"hex":return b(this,e,t,n);case"utf8":case"utf-8":return _(this,e,t,n);case"ascii":return w(this,e,t,n);case"latin1":case"binary":return x(this,e,t,n);case"base64":return E(this,e,t,n);case"ucs2":case"ucs-2":case"utf16le":case"utf-16le":return C(this,e,t,n);default:if(a)throw new TypeError("Unknown encoding: "+r);r=(""+r).toLowerCase(),a=!0}},u.prototype.toJSON=function(){return{type:"Buffer",data:Array.prototype.slice.call(this._arr||this,0)}};var k=4096;function O(e,t,n){var r="";n=Math.min(e.length,n);for(var o=t;or)&&(n=r);for(var o="",a=t;an)throw new RangeError("Trying to access beyond buffer length")}function M(e,t,n,r,o,a){if(!u.isBuffer(e))throw new TypeError('"buffer" argument must be a Buffer instance');if(t>o||te.length)throw new RangeError("Index out of range")}function P(e,t,n,r){t<0&&(t=65535+t+1);for(var o=0,a=Math.min(e.length-n,2);o>>8*(r?o:1-o)}function R(e,t,n,r){t<0&&(t=4294967295+t+1);for(var o=0,a=Math.min(e.length-n,4);o>>8*(r?o:3-o)&255}function D(e,t,n,r,o,a){if(n+r>e.length)throw new RangeError("Index out of range");if(n<0)throw new RangeError("Index out of range")}function L(e,t,n,r,a){return a||D(e,0,n,4),o.write(e,t,n,r,23,4),n+4}function B(e,t,n,r,a){return a||D(e,0,n,8),o.write(e,t,n,r,52,8),n+8}u.prototype.slice=function(e,t){var n,r=this.length;if((e=~~e)<0?(e+=r)<0&&(e=0):e>r&&(e=r),(t=void 0===t?r:~~t)<0?(t+=r)<0&&(t=0):t>r&&(t=r),t0&&(o*=256);)r+=this[e+--t]*o;return r},u.prototype.readUInt8=function(e,t){return t||N(e,1,this.length),this[e]},u.prototype.readUInt16LE=function(e,t){return t||N(e,2,this.length),this[e]|this[e+1]<<8},u.prototype.readUInt16BE=function(e,t){return t||N(e,2,this.length),this[e]<<8|this[e+1]},u.prototype.readUInt32LE=function(e,t){return t||N(e,4,this.length),(this[e]|this[e+1]<<8|this[e+2]<<16)+16777216*this[e+3]},u.prototype.readUInt32BE=function(e,t){return t||N(e,4,this.length),16777216*this[e]+(this[e+1]<<16|this[e+2]<<8|this[e+3])},u.prototype.readIntLE=function(e,t,n){e|=0,t|=0,n||N(e,t,this.length);for(var r=this[e],o=1,a=0;++a=(o*=128)&&(r-=Math.pow(2,8*t)),r},u.prototype.readIntBE=function(e,t,n){e|=0,t|=0,n||N(e,t,this.length);for(var r=t,o=1,a=this[e+--r];r>0&&(o*=256);)a+=this[e+--r]*o;return a>=(o*=128)&&(a-=Math.pow(2,8*t)),a},u.prototype.readInt8=function(e,t){return t||N(e,1,this.length),128&this[e]?-1*(255-this[e]+1):this[e]},u.prototype.readInt16LE=function(e,t){t||N(e,2,this.length);var n=this[e]|this[e+1]<<8;return 32768&n?4294901760|n:n},u.prototype.readInt16BE=function(e,t){t||N(e,2,this.length);var n=this[e+1]|this[e]<<8;return 32768&n?4294901760|n:n},u.prototype.readInt32LE=function(e,t){return t||N(e,4,this.length),this[e]|this[e+1]<<8|this[e+2]<<16|this[e+3]<<24},u.prototype.readInt32BE=function(e,t){return t||N(e,4,this.length),this[e]<<24|this[e+1]<<16|this[e+2]<<8|this[e+3]},u.prototype.readFloatLE=function(e,t){return t||N(e,4,this.length),o.read(this,e,!0,23,4)},u.prototype.readFloatBE=function(e,t){return t||N(e,4,this.length),o.read(this,e,!1,23,4)},u.prototype.readDoubleLE=function(e,t){return t||N(e,8,this.length),o.read(this,e,!0,52,8)},u.prototype.readDoubleBE=function(e,t){return t||N(e,8,this.length),o.read(this,e,!1,52,8)},u.prototype.writeUIntLE=function(e,t,n,r){(e=+e,t|=0,n|=0,r)||M(this,e,t,n,Math.pow(2,8*n)-1,0);var o=1,a=0;for(this[t]=255&e;++a=0&&(a*=256);)this[t+o]=e/a&255;return t+n},u.prototype.writeUInt8=function(e,t,n){return e=+e,t|=0,n||M(this,e,t,1,255,0),u.TYPED_ARRAY_SUPPORT||(e=Math.floor(e)),this[t]=255&e,t+1},u.prototype.writeUInt16LE=function(e,t,n){return e=+e,t|=0,n||M(this,e,t,2,65535,0),u.TYPED_ARRAY_SUPPORT?(this[t]=255&e,this[t+1]=e>>>8):P(this,e,t,!0),t+2},u.prototype.writeUInt16BE=function(e,t,n){return e=+e,t|=0,n||M(this,e,t,2,65535,0),u.TYPED_ARRAY_SUPPORT?(this[t]=e>>>8,this[t+1]=255&e):P(this,e,t,!1),t+2},u.prototype.writeUInt32LE=function(e,t,n){return e=+e,t|=0,n||M(this,e,t,4,4294967295,0),u.TYPED_ARRAY_SUPPORT?(this[t+3]=e>>>24,this[t+2]=e>>>16,this[t+1]=e>>>8,this[t]=255&e):R(this,e,t,!0),t+4},u.prototype.writeUInt32BE=function(e,t,n){return e=+e,t|=0,n||M(this,e,t,4,4294967295,0),u.TYPED_ARRAY_SUPPORT?(this[t]=e>>>24,this[t+1]=e>>>16,this[t+2]=e>>>8,this[t+3]=255&e):R(this,e,t,!1),t+4},u.prototype.writeIntLE=function(e,t,n,r){if(e=+e,t|=0,!r){var o=Math.pow(2,8*n-1);M(this,e,t,n,o-1,-o)}var a=0,i=1,s=0;for(this[t]=255&e;++a>0)-s&255;return t+n},u.prototype.writeIntBE=function(e,t,n,r){if(e=+e,t|=0,!r){var o=Math.pow(2,8*n-1);M(this,e,t,n,o-1,-o)}var a=n-1,i=1,s=0;for(this[t+a]=255&e;--a>=0&&(i*=256);)e<0&&0===s&&0!==this[t+a+1]&&(s=1),this[t+a]=(e/i>>0)-s&255;return t+n},u.prototype.writeInt8=function(e,t,n){return e=+e,t|=0,n||M(this,e,t,1,127,-128),u.TYPED_ARRAY_SUPPORT||(e=Math.floor(e)),e<0&&(e=255+e+1),this[t]=255&e,t+1},u.prototype.writeInt16LE=function(e,t,n){return e=+e,t|=0,n||M(this,e,t,2,32767,-32768),u.TYPED_ARRAY_SUPPORT?(this[t]=255&e,this[t+1]=e>>>8):P(this,e,t,!0),t+2},u.prototype.writeInt16BE=function(e,t,n){return e=+e,t|=0,n||M(this,e,t,2,32767,-32768),u.TYPED_ARRAY_SUPPORT?(this[t]=e>>>8,this[t+1]=255&e):P(this,e,t,!1),t+2},u.prototype.writeInt32LE=function(e,t,n){return e=+e,t|=0,n||M(this,e,t,4,2147483647,-2147483648),u.TYPED_ARRAY_SUPPORT?(this[t]=255&e,this[t+1]=e>>>8,this[t+2]=e>>>16,this[t+3]=e>>>24):R(this,e,t,!0),t+4},u.prototype.writeInt32BE=function(e,t,n){return e=+e,t|=0,n||M(this,e,t,4,2147483647,-2147483648),e<0&&(e=4294967295+e+1),u.TYPED_ARRAY_SUPPORT?(this[t]=e>>>24,this[t+1]=e>>>16,this[t+2]=e>>>8,this[t+3]=255&e):R(this,e,t,!1),t+4},u.prototype.writeFloatLE=function(e,t,n){return L(this,e,t,!0,n)},u.prototype.writeFloatBE=function(e,t,n){return L(this,e,t,!1,n)},u.prototype.writeDoubleLE=function(e,t,n){return B(this,e,t,!0,n)},u.prototype.writeDoubleBE=function(e,t,n){return B(this,e,t,!1,n)},u.prototype.copy=function(e,t,n,r){if(n||(n=0),r||0===r||(r=this.length),t>=e.length&&(t=e.length),t||(t=0),r>0&&r=this.length)throw new RangeError("sourceStart out of bounds");if(r<0)throw new RangeError("sourceEnd out of bounds");r>this.length&&(r=this.length),e.length-t=0;--o)e[o+t]=this[o+n];else if(a<1e3||!u.TYPED_ARRAY_SUPPORT)for(o=0;o>>=0,n=void 0===n?this.length:n>>>0,e||(e=0),"number"==typeof e)for(a=t;a55295&&n<57344){if(!o){if(n>56319){(t-=3)>-1&&a.push(239,191,189);continue}if(i+1===r){(t-=3)>-1&&a.push(239,191,189);continue}o=n;continue}if(n<56320){(t-=3)>-1&&a.push(239,191,189),o=n;continue}n=65536+(o-55296<<10|n-56320)}else o&&(t-=3)>-1&&a.push(239,191,189);if(o=null,n<128){if((t-=1)<0)break;a.push(n)}else if(n<2048){if((t-=2)<0)break;a.push(n>>6|192,63&n|128)}else if(n<65536){if((t-=3)<0)break;a.push(n>>12|224,n>>6&63|128,63&n|128)}else{if(!(n<1114112))throw new Error("Invalid code point");if((t-=4)<0)break;a.push(n>>18|240,n>>12&63|128,n>>6&63|128,63&n|128)}}return a}function z(e){return r.toByteArray(function(e){if((e=function(e){return e.trim?e.trim():e.replace(/^\s+|\s+$/g,"")}(e).replace(F,"")).length<2)return"";for(;e.length%4!=0;)e+="=";return e}(e))}function V(e,t,n,r){for(var o=0;o=t.length||o>=e.length);++o)t[o+n]=e[o];return o}}).call(this,n(54))},function(e,t,n){e.exports=n(857)},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(String(e)+" is not a function");return e}},function(e,t,n){var r=n(149),o=Math.min;e.exports=function(e){return e>0?o(r(e),9007199254740991):0}},function(e,t,n){"use strict";function r(e){return function(){return e}}var o=function(){};o.thatReturns=r,o.thatReturnsFalse=r(!1),o.thatReturnsTrue=r(!0),o.thatReturnsNull=r(null),o.thatReturnsThis=function(){return this},o.thatReturnsArgument=function(e){return e},e.exports=o},function(e,t,n){"use strict";var r=n(31),o=n(40),a=n(467),i=n(123),s=n(468),u=n(139),c=n(200),l=n(26),p=[],f=0,h=a.getPooled(),d=!1,v=null;function m(){x.ReactReconcileTransaction&&v||r("123")}var g=[{initialize:function(){this.dirtyComponentsLength=p.length},close:function(){this.dirtyComponentsLength!==p.length?(p.splice(0,this.dirtyComponentsLength),w()):p.length=0}},{initialize:function(){this.callbackQueue.reset()},close:function(){this.callbackQueue.notifyAll()}}];function y(){this.reinitializeTransaction(),this.dirtyComponentsLength=null,this.callbackQueue=a.getPooled(),this.reconcileTransaction=x.ReactReconcileTransaction.getPooled(!0)}function b(e,t){return e._mountOrder-t._mountOrder}function _(e){var t=e.dirtyComponentsLength;t!==p.length&&r("124",t,p.length),p.sort(b),f++;for(var n=0;nE;E++)if((f||E in _)&&(y=w(g=_[E],E,b),e))if(t)S[E]=y;else if(y)switch(e){case 3:return!0;case 5:return g;case 6:return E;case 2:u.call(S,g)}else if(l)return!1;return p?-1:c||l?l:S}};e.exports={forEach:c(0),map:c(1),filter:c(2),some:c(3),every:c(4),find:c(5),findIndex:c(6)}},function(e,t,n){"use strict";e.exports={current:null}},function(e,t){e.exports=function(e){return null!=e&&"object"==typeof e}},function(e,t){var n,r,o=e.exports={};function a(){throw new Error("setTimeout has not been defined")}function i(){throw new Error("clearTimeout has not been defined")}function s(e){if(n===setTimeout)return setTimeout(e,0);if((n===a||!n)&&setTimeout)return n=setTimeout,setTimeout(e,0);try{return n(e,0)}catch(t){try{return n.call(null,e,0)}catch(t){return n.call(this,e,0)}}}!function(){try{n="function"==typeof setTimeout?setTimeout:a}catch(e){n=a}try{r="function"==typeof clearTimeout?clearTimeout:i}catch(e){r=i}}();var u,c=[],l=!1,p=-1;function f(){l&&u&&(l=!1,u.length?c=u.concat(c):p=-1,c.length&&h())}function h(){if(!l){var e=s(f);l=!0;for(var t=c.length;t;){for(u=c,c=[];++p1)for(var n=1;n0&&"/"!==t[0]}));function Ce(e,t,n){var r;t=t||[];var o=we.apply(void 0,A()(r=[e]).call(r,O()(t))).get("parameters",Object(I.List)());return f()(o).call(o,(function(e,t){var r=n&&"body"===t.get("in")?t.get("value_xml"):t.get("value");return e.set(Object(T.B)(t,{allowHashes:!1}),r)}),Object(I.fromJS)({}))}function Se(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"";if(I.List.isList(e))return u()(e).call(e,(function(e){return I.Map.isMap(e)&&e.get("in")===t}))}function Ae(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"";if(I.List.isList(e))return u()(e).call(e,(function(e){return I.Map.isMap(e)&&e.get("type")===t}))}function ke(e,t){var n,r;t=t||[];var o=z(e).getIn(A()(n=["paths"]).call(n,O()(t)),Object(I.fromJS)({})),a=e.getIn(A()(r=["meta","paths"]).call(r,O()(t)),Object(I.fromJS)({})),i=Oe(e,t),s=o.get("parameters")||new I.List,u=a.get("consumes_value")?a.get("consumes_value"):Ae(s,"file")?"multipart/form-data":Ae(s,"formData")?"application/x-www-form-urlencoded":void 0;return Object(I.fromJS)({requestContentType:u,responseContentType:i})}function Oe(e,t){var n,r;t=t||[];var o=z(e).getIn(A()(n=["paths"]).call(n,O()(t)),null);if(null!==o){var a=e.getIn(A()(r=["meta","paths"]).call(r,O()(t),["produces_value"]),null),i=o.getIn(["produces",0],null);return a||i||"application/json"}}function je(e,t){var n;t=t||[];var r=z(e),o=r.getIn(A()(n=["paths"]).call(n,O()(t)),null);if(null!==o){var a=t,s=i()(a,1)[0],u=o.get("produces",null),c=r.getIn(["paths",s,"produces"],null),l=r.getIn(["produces"],null);return u||c||l}}function Te(e,t){var n;t=t||[];var r=z(e),o=r.getIn(A()(n=["paths"]).call(n,O()(t)),null);if(null!==o){var a=t,s=i()(a,1)[0],u=o.get("consumes",null),c=r.getIn(["paths",s,"consumes"],null),l=r.getIn(["consumes"],null);return u||c||l}}var Ie=function(e,t,n){var r=e.get("url").match(/^([a-z][a-z0-9+\-.]*):/),a=o()(r)?r[1]:null;return e.getIn(["scheme",t,n])||e.getIn(["scheme","_defaultScheme"])||a||""},Ne=function(e,t,n){var r;return _()(r=["http","https"]).call(r,Ie(e,t,n))>-1},Me=function(e,t){var n;t=t||[];var r=e.getIn(A()(n=["meta","paths"]).call(n,O()(t),["parameters"]),Object(I.fromJS)([])),o=!0;return x()(r).call(r,(function(e){var t=e.get("errors");t&&t.count()&&(o=!1)})),o},Pe=function(e,t){var n,r,o={requestBody:!1,requestContentType:{}},a=e.getIn(A()(n=["resolvedSubtrees","paths"]).call(n,O()(t),["requestBody"]),Object(I.fromJS)([]));return a.size<1||(a.getIn(["required"])&&(o.requestBody=a.getIn(["required"])),x()(r=a.getIn(["content"]).entrySeq()).call(r,(function(e){var t=e[0];if(e[1].getIn(["schema","required"])){var n=e[1].getIn(["schema","required"]).toJS();o.requestContentType[t]=n}}))),o},Re=function(e,t,n,r){var o,a=e.getIn(A()(o=["resolvedSubtrees","paths"]).call(o,O()(t),["requestBody","content"]),Object(I.fromJS)([]));if(a.size<2||!n||!r)return!1;var i=a.getIn([n,"schema","properties"],Object(I.fromJS)([])),s=a.getIn([r,"schema","properties"],Object(I.fromJS)([]));return!!i.equals(s)};function De(e){return I.Map.isMap(e)?e:new I.Map}},function(e,t,n){"use strict";(function(t){var r=n(891),o=n(892),a=/^[A-Za-z][A-Za-z0-9+-.]*:\/\//,i=/^([a-z][a-z0-9.+-]*:)?(\/\/)?([\S\s]*)/i,s=new RegExp("^[\\x09\\x0A\\x0B\\x0C\\x0D\\x20\\xA0\\u1680\\u180E\\u2000\\u2001\\u2002\\u2003\\u2004\\u2005\\u2006\\u2007\\u2008\\u2009\\u200A\\u202F\\u205F\\u3000\\u2028\\u2029\\uFEFF]+");function u(e){return(e||"").toString().replace(s,"")}var c=[["#","hash"],["?","query"],function(e){return e.replace("\\","/")},["/","pathname"],["@","auth",1],[NaN,"host",void 0,1,1],[/:(\d+)$/,"port",void 0,1],[NaN,"hostname",void 0,1,1]],l={hash:1,query:1};function p(e){var n,r=("undefined"!=typeof window?window:void 0!==t?t:"undefined"!=typeof self?self:{}).location||{},o={},i=typeof(e=e||r);if("blob:"===e.protocol)o=new h(unescape(e.pathname),{});else if("string"===i)for(n in o=new h(e,{}),l)delete o[n];else if("object"===i){for(n in e)n in l||(o[n]=e[n]);void 0===o.slashes&&(o.slashes=a.test(e.href))}return o}function f(e){e=u(e);var t=i.exec(e);return{protocol:t[1]?t[1].toLowerCase():"",slashes:!!t[2],rest:t[3]}}function h(e,t,n){if(e=u(e),!(this instanceof h))return new h(e,t,n);var a,i,s,l,d,v,m=c.slice(),g=typeof t,y=this,b=0;for("object"!==g&&"string"!==g&&(n=t,t=null),n&&"function"!=typeof n&&(n=o.parse),t=p(t),a=!(i=f(e||"")).protocol&&!i.slashes,y.slashes=i.slashes||a&&t.slashes,y.protocol=i.protocol||t.protocol||"",e=i.rest,i.slashes||(m[3]=[/(.*)/,"pathname"]);b=n.length?{value:void 0,done:!0}:(e=r(n,o),t.index+=e.length,{value:e,done:!1})}))},function(e,t,n){"use strict";e.exports=function(e){if("function"!=typeof e)throw new TypeError(e+" is not a function");return e}},function(e,t,n){e.exports=n(626)},function(e,t,n){e.exports=n(828)},function(e,t,n){"use strict";var r=n(870);e.exports=r},function(e,t,n){"use strict";n.r(t),n.d(t,"UPDATE_LAYOUT",(function(){return o})),n.d(t,"UPDATE_FILTER",(function(){return a})),n.d(t,"UPDATE_MODE",(function(){return i})),n.d(t,"SHOW",(function(){return s})),n.d(t,"updateLayout",(function(){return u})),n.d(t,"updateFilter",(function(){return c})),n.d(t,"show",(function(){return l})),n.d(t,"changeMode",(function(){return p}));var r=n(7),o="layout_update_layout",a="layout_update_filter",i="layout_update_mode",s="layout_show";function u(e){return{type:o,payload:e}}function c(e){return{type:a,payload:e}}function l(e){var t=!(arguments.length>1&&void 0!==arguments[1])||arguments[1];return e=Object(r.w)(e),{type:s,payload:{thing:e,shown:t}}}function p(e){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"";return e=Object(r.w)(e),{type:i,payload:{thing:e,mode:t}}}},function(e,t,n){"use strict";var r=n(1052),o=n(1053);function a(){this.protocol=null,this.slashes=null,this.auth=null,this.host=null,this.port=null,this.hostname=null,this.hash=null,this.search=null,this.query=null,this.pathname=null,this.path=null,this.href=null}t.parse=b,t.resolve=function(e,t){return b(e,!1,!0).resolve(t)},t.resolveObject=function(e,t){return e?b(e,!1,!0).resolveObject(t):t},t.format=function(e){o.isString(e)&&(e=b(e));return e instanceof a?e.format():a.prototype.format.call(e)},t.Url=a;var i=/^([a-z0-9.+-]+:)/i,s=/:[0-9]*$/,u=/^(\/\/?(?!\/)[^\?\s]*)(\?[^\s]*)?$/,c=["{","}","|","\\","^","`"].concat(["<",">",'"',"`"," ","\r","\n","\t"]),l=["'"].concat(c),p=["%","/","?",";","#"].concat(l),f=["/","?","#"],h=/^[+a-z0-9A-Z_-]{0,63}$/,d=/^([+a-z0-9A-Z_-]{0,63})(.*)$/,v={javascript:!0,"javascript:":!0},m={javascript:!0,"javascript:":!0},g={http:!0,https:!0,ftp:!0,gopher:!0,file:!0,"http:":!0,"https:":!0,"ftp:":!0,"gopher:":!0,"file:":!0},y=n(1054);function b(e,t,n){if(e&&o.isObject(e)&&e instanceof a)return e;var r=new a;return r.parse(e,t,n),r}a.prototype.parse=function(e,t,n){if(!o.isString(e))throw new TypeError("Parameter 'url' must be a string, not "+typeof e);var a=e.indexOf("?"),s=-1!==a&&a127?M+="x":M+=N[P];if(!M.match(h)){var D=T.slice(0,k),L=T.slice(k+1),B=N.match(d);B&&(D.push(B[1]),L.unshift(B[2])),L.length&&(b="/"+L.join(".")+b),this.hostname=D.join(".");break}}}this.hostname.length>255?this.hostname="":this.hostname=this.hostname.toLowerCase(),j||(this.hostname=r.toASCII(this.hostname));var F=this.port?":"+this.port:"",U=this.hostname||"";this.host=U+F,this.href+=this.host,j&&(this.hostname=this.hostname.substr(1,this.hostname.length-2),"/"!==b[0]&&(b="/"+b))}if(!v[x])for(k=0,I=l.length;k0)&&n.host.split("@"))&&(n.auth=j.shift(),n.host=n.hostname=j.shift());return n.search=e.search,n.query=e.query,o.isNull(n.pathname)&&o.isNull(n.search)||(n.path=(n.pathname?n.pathname:"")+(n.search?n.search:"")),n.href=n.format(),n}if(!E.length)return n.pathname=null,n.search?n.path="/"+n.search:n.path=null,n.href=n.format(),n;for(var S=E.slice(-1)[0],A=(n.host||e.host||E.length>1)&&("."===S||".."===S)||""===S,k=0,O=E.length;O>=0;O--)"."===(S=E[O])?E.splice(O,1):".."===S?(E.splice(O,1),k++):k&&(E.splice(O,1),k--);if(!w&&!x)for(;k--;k)E.unshift("..");!w||""===E[0]||E[0]&&"/"===E[0].charAt(0)||E.unshift(""),A&&"/"!==E.join("/").substr(-1)&&E.push("");var j,T=""===E[0]||E[0]&&"/"===E[0].charAt(0);C&&(n.hostname=n.host=T?"":E.length?E.shift():"",(j=!!(n.host&&n.host.indexOf("@")>0)&&n.host.split("@"))&&(n.auth=j.shift(),n.host=n.hostname=j.shift()));return(w=w||n.host&&E.length)&&!T&&E.unshift(""),E.length?n.pathname=E.join("/"):(n.pathname=null,n.path=null),o.isNull(n.pathname)&&o.isNull(n.search)||(n.path=(n.pathname?n.pathname:"")+(n.search?n.search:"")),n.auth=e.auth||n.auth,n.slashes=n.slashes||e.slashes,n.href=n.format(),n},a.prototype.parseHost=function(){var e=this.host,t=s.exec(e);t&&(":"!==(t=t[0])&&(this.port=t.substr(1)),e=e.substr(0,e.length-t.length)),e&&(this.hostname=e)}},function(e,t,n){var r=n(418),o=n(159),a=n(189),i=n(53),s=n(117),u=n(190),c=n(158),l=n(247),p=Object.prototype.hasOwnProperty;e.exports=function(e){if(null==e)return!0;if(s(e)&&(i(e)||"string"==typeof e||"function"==typeof e.splice||u(e)||l(e)||a(e)))return!e.length;var t=o(e);if("[object Map]"==t||"[object Set]"==t)return!e.size;if(c(e))return!r(e).length;for(var n in e)if(p.call(e,n))return!1;return!0}},function(e,t,n){var r=n(48),o=n(174),a=n(107),i=n(69),s=n(176),u=n(52),c=n(353),l=Object.getOwnPropertyDescriptor;t.f=r?l:function(e,t){if(e=i(e),t=s(t,!0),c)try{return l(e,t)}catch(e){}if(u(e,t))return a(!o.f.call(e,t),e[t])}},function(e,t){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t){var n={}.toString;e.exports=function(e){return n.call(e).slice(8,-1)}},function(e,t,n){var r=n(79);e.exports=function(e,t,n){if(r(e),void 0===t)return e;switch(n){case 0:return function(){return e.call(t)};case 1:return function(n){return e.call(t,n)};case 2:return function(n,r){return e.call(t,n,r)};case 3:return function(n,r,o){return e.call(t,n,r,o)}}return function(){return e.apply(t,arguments)}}},function(e,t,n){var r,o=n(55),a=n(231),i=n(226),s=n(150),u=n(366),c=n(223),l=n(178),p=l("IE_PROTO"),f=function(){},h=function(e){return"