From 92ff990b12ee414e7a5b323ed8a83f0a54bd5ea3 Mon Sep 17 00:00:00 2001 From: SanduDS Date: Thu, 17 Feb 2022 14:00:54 +0530 Subject: [PATCH] Add commercetools connector --- openapi/commercetools/.gitignore | 1 + openapi/commercetools/Ballerina.toml | 13 + openapi/commercetools/Dependencies.toml | 285 + openapi/commercetools/Module.md | 10 + openapi/commercetools/Package.md | 18 + openapi/commercetools/client.bal | 3882 + openapi/commercetools/icon.png | Bin 0 -> 5725 bytes openapi/commercetools/openapi.yml | 81946 ++++++++++++++++++++++ openapi/commercetools/types.bal | 10675 +++ openapi/commercetools/utils.bal | 245 + 10 files changed, 97075 insertions(+) create mode 100644 openapi/commercetools/.gitignore create mode 100644 openapi/commercetools/Ballerina.toml create mode 100644 openapi/commercetools/Dependencies.toml create mode 100644 openapi/commercetools/Module.md create mode 100644 openapi/commercetools/Package.md create mode 100644 openapi/commercetools/client.bal create mode 100644 openapi/commercetools/icon.png create mode 100644 openapi/commercetools/openapi.yml create mode 100644 openapi/commercetools/types.bal create mode 100644 openapi/commercetools/utils.bal diff --git a/openapi/commercetools/.gitignore b/openapi/commercetools/.gitignore new file mode 100644 index 000000000..eb5a316cb --- /dev/null +++ b/openapi/commercetools/.gitignore @@ -0,0 +1 @@ +target diff --git a/openapi/commercetools/Ballerina.toml b/openapi/commercetools/Ballerina.toml new file mode 100644 index 000000000..e81cbc3ce --- /dev/null +++ b/openapi/commercetools/Ballerina.toml @@ -0,0 +1,13 @@ +[package] +license = ["Apache-2.0"] +keywords = ["Commerce/eCommerce", "Cost/Paid"] +org = "ballerinax" +name = "commercetools" +icon = "icon.png" +distribution = "slbeta6" +repository = "https://github.com/ballerina-platform/ballerinax-openapi-connectors" +version = "1.0.0" +authors = ["Ballerina"] + +[build-options] +observabilityIncluded = true diff --git a/openapi/commercetools/Dependencies.toml b/openapi/commercetools/Dependencies.toml new file mode 100644 index 000000000..49181e2ba --- /dev/null +++ b/openapi/commercetools/Dependencies.toml @@ -0,0 +1,285 @@ +# AUTO-GENERATED FILE. DO NOT MODIFY. + +# This file is auto-generated by Ballerina for managing dependency versions. +# It should not be modified by hand. + +[ballerina] +dependencies-toml-version = "2" + +[[package]] +org = "ballerina" +name = "auth" +version = "2.1.0" +dependencies = [ + {org = "ballerina", name = "crypto"}, + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "lang.array"}, + {org = "ballerina", name = "lang.string"}, + {org = "ballerina", name = "log"}, + {org = "ballerina", name = "regex"} +] + +[[package]] +org = "ballerina" +name = "cache" +version = "3.1.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "task"}, + {org = "ballerina", name = "time"} +] + +[[package]] +org = "ballerina" +name = "crypto" +version = "2.1.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "time"} +] + +[[package]] +org = "ballerina" +name = "file" +version = "1.1.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "log"}, + {org = "ballerina", name = "os"}, + {org = "ballerina", name = "regex"}, + {org = "ballerina", name = "time"} +] + +[[package]] +org = "ballerina" +name = "http" +version = "2.1.0" +dependencies = [ + {org = "ballerina", name = "auth"}, + {org = "ballerina", name = "cache"}, + {org = "ballerina", name = "crypto"}, + {org = "ballerina", name = "file"}, + {org = "ballerina", name = "io"}, + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "jwt"}, + {org = "ballerina", name = "lang.array"}, + {org = "ballerina", name = "lang.decimal"}, + {org = "ballerina", name = "lang.int"}, + {org = "ballerina", name = "lang.runtime"}, + {org = "ballerina", name = "lang.string"}, + {org = "ballerina", name = "lang.value"}, + {org = "ballerina", name = "log"}, + {org = "ballerina", name = "mime"}, + {org = "ballerina", name = "oauth2"}, + {org = "ballerina", name = "observe"}, + {org = "ballerina", name = "regex"}, + {org = "ballerina", name = "time"}, + {org = "ballerina", name = "url"} +] +modules = [ + {org = "ballerina", packageName = "http", moduleName = "http"} +] + +[[package]] +org = "ballerina" +name = "io" +version = "1.1.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "lang.value"} +] + +[[package]] +org = "ballerina" +name = "jballerina.java" +version = "0.0.0" + +[[package]] +org = "ballerina" +name = "jwt" +version = "2.1.0" +dependencies = [ + {org = "ballerina", name = "cache"}, + {org = "ballerina", name = "crypto"}, + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "lang.int"}, + {org = "ballerina", name = "lang.string"}, + {org = "ballerina", name = "log"}, + {org = "ballerina", name = "regex"}, + {org = "ballerina", name = "time"} +] + +[[package]] +org = "ballerina" +name = "lang.__internal" +version = "0.0.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "lang.object"} +] + +[[package]] +org = "ballerina" +name = "lang.array" +version = "0.0.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "lang.__internal"} +] + +[[package]] +org = "ballerina" +name = "lang.decimal" +version = "0.0.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"} +] + +[[package]] +org = "ballerina" +name = "lang.int" +version = "0.0.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"} +] + +[[package]] +org = "ballerina" +name = "lang.object" +version = "0.0.0" + +[[package]] +org = "ballerina" +name = "lang.runtime" +version = "0.0.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"} +] + +[[package]] +org = "ballerina" +name = "lang.string" +version = "0.0.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"} +] + +[[package]] +org = "ballerina" +name = "lang.value" +version = "0.0.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"} +] + +[[package]] +org = "ballerina" +name = "log" +version = "2.1.0" +dependencies = [ + {org = "ballerina", name = "io"}, + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "lang.value"}, + {org = "ballerina", name = "observe"} +] + +[[package]] +org = "ballerina" +name = "mime" +version = "2.1.0" +dependencies = [ + {org = "ballerina", name = "io"}, + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "lang.int"} +] + +[[package]] +org = "ballerina" +name = "oauth2" +version = "2.1.0" +dependencies = [ + {org = "ballerina", name = "cache"}, + {org = "ballerina", name = "crypto"}, + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "log"}, + {org = "ballerina", name = "time"} +] + +[[package]] +org = "ballerina" +name = "observe" +version = "1.0.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"} +] + +[[package]] +org = "ballerina" +name = "os" +version = "1.1.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"} +] + +[[package]] +org = "ballerina" +name = "regex" +version = "1.1.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"} +] + +[[package]] +org = "ballerina" +name = "task" +version = "2.1.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "time"} +] + +[[package]] +org = "ballerina" +name = "time" +version = "2.1.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"} +] + +[[package]] +org = "ballerina" +name = "url" +version = "2.1.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"} +] +modules = [ + {org = "ballerina", packageName = "url", moduleName = "url"} +] + +[[package]] +org = "ballerinai" +name = "observe" +version = "0.0.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "observe"} +] +modules = [ + {org = "ballerinai", packageName = "observe", moduleName = "observe"} +] + +[[package]] +org = "ballerinax" +name = "commercetools" +version = "1.0.0" +dependencies = [ + {org = "ballerina", name = "http"}, + {org = "ballerina", name = "url"}, + {org = "ballerinai", name = "observe"} +] +modules = [ + {org = "ballerinax", packageName = "commercetools", moduleName = "commercetools"} +] + + diff --git a/openapi/commercetools/Module.md b/openapi/commercetools/Module.md new file mode 100644 index 000000000..1c21c7813 --- /dev/null +++ b/openapi/commercetools/Module.md @@ -0,0 +1,10 @@ +## Overview +This is a generated connector for [Commercetools API v1](https://docs.commercetools.com/api/) OpenAPI specification. + +The commercetools Platform HTTP API offers an interface for programmatic access to the data stored on the platform and associated functionality. + +## Prerequisites + +Before using this connector in your Ballerina application, complete the following: + +* Create and configure an OAuth2 client credentials by following [this guide](https://docs.commercetools.com/api/authorization). \ No newline at end of file diff --git a/openapi/commercetools/Package.md b/openapi/commercetools/Package.md new file mode 100644 index 000000000..5bf7ceeac --- /dev/null +++ b/openapi/commercetools/Package.md @@ -0,0 +1,18 @@ +Connects to [Commercetools API v1](https://docs.commercetools.com/api/)) from Ballerina + +## Package overview +The `ballerinax/commercetools` is a [Ballerina](https://ballerina.io/) connector to access commercetools platform. + +### Compatibility +| | Version | +|--------------------|-----------------------------| +| Ballerina Language | Ballerina Swan Lake Beta6 | +| Commercetools API | 1.0.0 | + +## Report issues +To report bugs, request new features, start new discussions, view project boards, etc., go to the [Ballerina Extended Library repository](https://github.com/ballerina-platform/ballerina-extended-library) + +## Useful links +- Discuss code changes of the Ballerina project in [ballerina-dev@googlegroups.com](mailto:ballerina-dev@googlegroups.com). +- Chat live with us via our [Slack channel](https://ballerina.io/community/slack/). +- Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag \ No newline at end of file diff --git a/openapi/commercetools/client.bal b/openapi/commercetools/client.bal new file mode 100644 index 000000000..51d1787d4 --- /dev/null +++ b/openapi/commercetools/client.bal @@ -0,0 +1,3882 @@ +// Copyright (c) 2022 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 Inc. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +import ballerina/http; + +# Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. +public type ClientConfig record {| + # Configurations related to client authentication + http:OAuth2ClientCredentialsGrantConfig|http:BearerTokenConfig auth; + # The HTTP version understood by the client + string httpVersion = "1.1"; + # Configurations related to HTTP/1.x protocol + http:ClientHttp1Settings http1Settings = {}; + # Configurations related to HTTP/2 protocol + http:ClientHttp2Settings http2Settings = {}; + # The maximum time to wait (in seconds) for a response before closing the connection + decimal timeout = 60; + # The choice of setting `forwarded`/`x-forwarded` header + string forwarded = "disable"; + # Configurations associated with Redirection + http:FollowRedirects? followRedirects = (); + # Configurations associated with request pooling + http:PoolConfiguration? poolConfig = (); + # HTTP caching related configurations + http:CacheConfig cache = {}; + # Specifies the way of handling compression (`accept-encoding`) header + http:Compression compression = http:COMPRESSION_AUTO; + # Configurations associated with the behaviour of the Circuit Breaker + http:CircuitBreakerConfig? circuitBreaker = (); + # Configurations associated with retrying + http:RetryConfig? retryConfig = (); + # Configurations associated with cookies + http:CookieConfig? cookieConfig = (); + # Configurations associated with inbound response size limits + http:ResponseLimitConfigs responseLimits = {}; + # SSL/TLS-related options + http:ClientSecureSocket? secureSocket = (); +|}; + +# This is a generated connector for [Commercetools API v1](https://docs.commercetools.com/api/) OpenAPI specification. +# The commercetools Platform HTTP API offers an interface for programmatic access to the data stored on the platform and associated functionality. +@display {label: "Commercetools", iconPath: "icon.png"} +public isolated client class Client { + final http:Client clientEp; + # Gets invoked to initialize the `connector`. + # The connector initialization requires setting the API credentials. Create and configure an OAuth2 client credentials by following [this guide](https://docs.commercetools.com/api/authorization). + # + # + clientConfig - The configurations to be used when initializing the `connector` + # + serviceUrl - URL of the target service + # + return - An error if connector initialization failed + public isolated function init(ClientConfig clientConfig, string serviceUrl) returns error? { + http:Client httpEp = check new (serviceUrl, clientConfig); + self.clientEp = httpEp; + return; + } + # The Endpoint is responding a limited set of information about settings and configuration of the project. + # + # + return - 200 + remote isolated function byProjectKeyGet(string projectKey) returns Project|error { + string resourcePath = string `/${projectKey}`; + Project response = check self.clientEp->get(resourcePath); + return response; + } + # Update project + # + # + return - 200 + remote isolated function byProjectKeyPost(string projectKey, ProjectUpdate payload) returns Project|error { + string resourcePath = string `/${projectKey}`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Project response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyApiClientsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ApiClientPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/api-clients`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ApiClientPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyApiClientsPost(string projectKey, ApiClientDraft payload, Expansion[]? expand = ()) returns ApiClient|error { + string resourcePath = string `/${projectKey}/api-clients`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ApiClient response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyApiClientsByIDGet(string projectKey, string iD) returns ApiClient|error { + string resourcePath = string `/${projectKey}/api-clients/${iD}`; + ApiClient response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyApiClientsByIDDelete(string projectKey, string iD) returns ApiClient|error { + string resourcePath = string `/${projectKey}/api-clients/${iD}`; + ApiClient response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartDiscountsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns CartDiscountPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/cart-discounts`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CartDiscountPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyCartDiscountsPost(string projectKey, CartDiscountDraft payload, Expansion[]? expand = ()) returns CartDiscount|error { + string resourcePath = string `/${projectKey}/cart-discounts`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CartDiscount response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartDiscountsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns CartDiscount|error { + string resourcePath = string `/${projectKey}/cart-discounts/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CartDiscount response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartDiscountsKeyByKeyPost(string projectKey, string 'key, CartDiscountUpdate payload, Expansion[]? expand = ()) returns CartDiscount|error { + string resourcePath = string `/${projectKey}/cart-discounts/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CartDiscount response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartDiscountsKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns CartDiscount|error { + string resourcePath = string `/${projectKey}/cart-discounts/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CartDiscount response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartDiscountsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns CartDiscount|error { + string resourcePath = string `/${projectKey}/cart-discounts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CartDiscount response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartDiscountsByIDPost(string projectKey, string iD, CartDiscountUpdate payload, Expansion[]? expand = ()) returns CartDiscount|error { + string resourcePath = string `/${projectKey}/cart-discounts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CartDiscount response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartDiscountsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns CartDiscount|error { + string resourcePath = string `/${projectKey}/cart-discounts/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CartDiscount response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns CartPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/carts`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CartPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Creating a cart can fail with an InvalidOperation if the referenced shipping method in the + # CartDraft has a predicate which does not match the cart. + # + # + return - 201 + remote isolated function byProjectKeyCartsPost(string projectKey, CartDraft payload, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/carts`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # Retrieves the active cart of the customer that has been modified most recently. + # It does not consider carts with CartOrigin Merchant. If no active cart exists, a 404 Not Found error is returned. + # + # The cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date, + # send an Update request with the Recalculate update action instead. + # + # + return - 200 + remote isolated function byProjectKeyCartsCustomerIdByCustomerIdGet(string projectKey, string customerId, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/carts/customer-id=${customerId}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->get(resourcePath); + return response; + } + # The cart may not contain up-to-date prices, discounts etc. + # If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead. + # + # + return - 200 + remote isolated function byProjectKeyCartsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/carts/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartsKeyByKeyPost(string projectKey, string 'key, CartUpdate payload, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/carts/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartsKeyByKeyDelete(string projectKey, string 'key, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/carts/key=${'key}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyCartsReplicatePost(string projectKey, ReplicaCartDraft payload) returns Cart|error { + string resourcePath = string `/${projectKey}/carts/replicate`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # The cart may not contain up-to-date prices, discounts etc. + # If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead. + # + # + return - 200 + remote isolated function byProjectKeyCartsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/carts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartsByIDPost(string projectKey, string iD, CartUpdate payload, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/carts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCartsByIDDelete(string projectKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/carts/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCategoriesGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns CategoryPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/categories`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CategoryPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Creating a category produces the CategoryCreated message. + # + # + return - 201 + remote isolated function byProjectKeyCategoriesPost(string projectKey, CategoryDraft payload, Expansion[]? expand = ()) returns Category|error { + string resourcePath = string `/${projectKey}/categories`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Category response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCategoriesKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns Category|error { + string resourcePath = string `/${projectKey}/categories/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Category response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCategoriesKeyByKeyPost(string projectKey, string 'key, CategoryUpdate payload, Expansion[]? expand = ()) returns Category|error { + string resourcePath = string `/${projectKey}/categories/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Category response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCategoriesKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns Category|error { + string resourcePath = string `/${projectKey}/categories/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Category response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCategoriesByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Category|error { + string resourcePath = string `/${projectKey}/categories/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Category response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCategoriesByIDPost(string projectKey, string iD, CategoryUpdate payload, Expansion[]? expand = ()) returns Category|error { + string resourcePath = string `/${projectKey}/categories/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Category response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCategoriesByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns Category|error { + string resourcePath = string `/${projectKey}/categories/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Category response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyChannelsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ChannelPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/channels`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ChannelPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyChannelsPost(string projectKey, ChannelDraft payload, Expansion[]? expand = ()) returns Channel|error { + string resourcePath = string `/${projectKey}/channels`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Channel response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyChannelsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Channel|error { + string resourcePath = string `/${projectKey}/channels/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Channel response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyChannelsByIDPost(string projectKey, string iD, ChannelUpdate payload, Expansion[]? expand = ()) returns Channel|error { + string resourcePath = string `/${projectKey}/channels/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Channel response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyChannelsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns Channel|error { + string resourcePath = string `/${projectKey}/channels/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Channel response = check self.clientEp->delete(resourcePath); + return response; + } + # The query endpoint allows to retrieve custom objects in a specific container or all custom objects. + # For performance reasons, it is highly advisable to query only for custom objects in a container by using + # the container field in the where predicate. + # + # + return - 200 + remote isolated function byProjectKeyCustomObjectsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns CustomObjectPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/custom-objects`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomObjectPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Creates a new custom object or updates an existing custom object. + # If an object with the given container/key exists, + # the object will be replaced with the new value and the version is incremented. + # If the request contains a version and an object with the given container/key exists then the version + # must match the version of the existing object. Concurrent updates for the same custom object still can result + # in a Conflict (409) even if the version is not provided. + # Fields with null values will not be saved. + # + # + return - 200 + remote isolated function byProjectKeyCustomObjectsPost(string projectKey, CustomObjectDraft payload, Expansion[]? expand = ()) returns CustomObject|error { + string resourcePath = string `/${projectKey}/custom-objects`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomObject response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomObjectsByContainerGet(string projectKey, string container, QueryPredicate[]? 'where = (), string[]? varAZaZ09 = (), Expansion[]? expand = ()) returns CustomObjectPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/custom-objects/${container}`; + map queryParam = {"where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09, "expand": expand}; + map queryParamEncoding = {"where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}, "expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomObjectPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Get CustomObject by container and key + # + # + return - 200 + remote isolated function byProjectKeyCustomObjectsByContainerByKeyGet(string projectKey, string container, string 'key, Expansion[]? expand = ()) returns CustomObject|error { + string resourcePath = string `/${projectKey}/custom-objects/${container}/${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomObject response = check self.clientEp->get(resourcePath); + return response; + } + # Delete CustomObject by container and key + # + # + return - 200 + remote isolated function byProjectKeyCustomObjectsByContainerByKeyDelete(string projectKey, string container, string 'key, float? 'version = (), boolean? dataErasure = (), Expansion[]? expand = ()) returns CustomObject|error { + string resourcePath = string `/${projectKey}/custom-objects/${container}/${'key}`; + map queryParam = {"version": 'version, "dataErasure": dataErasure, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomObject response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomerGroupsGet(string projectKey, QueryPredicate[]? 'where = (), Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), string[]? varAZaZ09 = ()) returns CustomerGroupPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/customer-groups`; + map queryParam = {"where": 'where, "expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"where": {style: FORM, explode: true}, "expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomerGroupPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyCustomerGroupsPost(string projectKey, CustomerGroupDraft payload, Expansion[]? expand = ()) returns CustomerGroup|error { + string resourcePath = string `/${projectKey}/customer-groups`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerGroup response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomerGroupsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns CustomerGroup|error { + string resourcePath = string `/${projectKey}/customer-groups/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomerGroup response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomerGroupsKeyByKeyPost(string projectKey, string 'key, CustomerGroupUpdate payload, Expansion[]? expand = ()) returns CustomerGroup|error { + string resourcePath = string `/${projectKey}/customer-groups/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerGroup response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomerGroupsKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns CustomerGroup|error { + string resourcePath = string `/${projectKey}/customer-groups/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomerGroup response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomerGroupsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns CustomerGroup|error { + string resourcePath = string `/${projectKey}/customer-groups/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomerGroup response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomerGroupsByIDPost(string projectKey, string iD, CustomerGroupUpdate payload, Expansion[]? expand = ()) returns CustomerGroup|error { + string resourcePath = string `/${projectKey}/customer-groups/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerGroup response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomerGroupsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns CustomerGroup|error { + string resourcePath = string `/${projectKey}/customer-groups/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomerGroup response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomersGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns CustomerPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/customers`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomerPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Creates a customer. If an anonymous cart is passed in, + # then the cart is assigned to the created customer and the version number of the Cart will increase. + # If the ID of an anonymous session is given, all carts and orders will be assigned to the created customer. + # + # + return - 201 + remote isolated function byProjectKeyCustomersPost(string projectKey, CustomerDraft payload, Expansion[]? expand = ()) returns CustomerSignInResult|error { + string resourcePath = string `/${projectKey}/customers`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerSignInResult response = check self.clientEp->post(resourcePath, request); + return response; + } + # Create a Token for verifying the Customer's Email + # + # + return - 200 + remote isolated function byProjectKeyCustomersEmailTokenPost(string projectKey, CustomerCreateEmailToken payload) returns CustomerToken|error { + string resourcePath = string `/${projectKey}/customers/email-token`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerToken response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomersEmailTokenByEmailTokenGet(string projectKey, string emailToken, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/customers/email-token=${emailToken}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->get(resourcePath); + return response; + } + # Verifies customer's email using a token. + # + # + return - The email was verified. + remote isolated function byProjectKeyCustomersEmailConfirmPost(string projectKey, CustomerEmailVerify payload) returns Customer|error { + string resourcePath = string `/${projectKey}/customers/email/confirm`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomersKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/customers/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomersKeyByKeyPost(string projectKey, string 'key, CustomerUpdate payload, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/customers/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomersKeyByKeyDelete(string projectKey, string 'key, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/customers/key=${'key}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->delete(resourcePath); + return response; + } + # Change a customers password + # + # + return - 200 + remote isolated function byProjectKeyCustomersPasswordPost(string projectKey, CustomerChangePassword payload) returns Customer|error { + string resourcePath = string `/${projectKey}/customers/password`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # The token value is used to reset the password of the customer with the given email. The token is + # valid only for 10 minutes. + # + # + return - 200 + remote isolated function byProjectKeyCustomersPasswordTokenPost(string projectKey, CustomerCreatePasswordResetToken payload) returns CustomerToken|error { + string resourcePath = string `/${projectKey}/customers/password-token`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerToken response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomersPasswordTokenByPasswordTokenGet(string projectKey, string passwordToken, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/customers/password-token=${passwordToken}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->get(resourcePath); + return response; + } + # Set a new password using a token. + # + # + return - 200 + remote isolated function byProjectKeyCustomersPasswordResetPost(string projectKey, CustomerResetPassword payload) returns Customer|error { + string resourcePath = string `/${projectKey}/customers/password/reset`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomersByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/customers/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomersByIDPost(string projectKey, string iD, CustomerUpdate payload, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/customers/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyCustomersByIDDelete(string projectKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/customers/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyDiscountCodesGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns DiscountCodePagedQueryResponse|error { + string resourcePath = string `/${projectKey}/discount-codes`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + DiscountCodePagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyDiscountCodesPost(string projectKey, DiscountCodeDraft payload, Expansion[]? expand = ()) returns DiscountCode|error { + string resourcePath = string `/${projectKey}/discount-codes`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + DiscountCode response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyDiscountCodesByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns DiscountCode|error { + string resourcePath = string `/${projectKey}/discount-codes/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + DiscountCode response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyDiscountCodesByIDPost(string projectKey, string iD, DiscountCodeUpdate payload, Expansion[]? expand = ()) returns DiscountCode|error { + string resourcePath = string `/${projectKey}/discount-codes/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + DiscountCode response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyDiscountCodesByIDDelete(string projectKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns DiscountCode|error { + string resourcePath = string `/${projectKey}/discount-codes/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + DiscountCode response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyExtensionsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ExtensionPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/extensions`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ExtensionPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Currently, a maximum of 25 extensions can be created per project. + # + # + return - 201 + remote isolated function byProjectKeyExtensionsPost(string projectKey, ExtensionDraft payload, Expansion[]? expand = ()) returns Extension|error { + string resourcePath = string `/${projectKey}/extensions`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Extension response = check self.clientEp->post(resourcePath, request); + return response; + } + # Retrieves the representation of an extension by its key. + # + # + return - 200 + remote isolated function byProjectKeyExtensionsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns Extension|error { + string resourcePath = string `/${projectKey}/extensions/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Extension response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyExtensionsKeyByKeyPost(string projectKey, string 'key, ExtensionUpdate payload, Expansion[]? expand = ()) returns Extension|error { + string resourcePath = string `/${projectKey}/extensions/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Extension response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyExtensionsKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns Extension|error { + string resourcePath = string `/${projectKey}/extensions/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Extension response = check self.clientEp->delete(resourcePath); + return response; + } + # Retrieves the representation of an extension by its id. + # + # + return - 200 + remote isolated function byProjectKeyExtensionsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Extension|error { + string resourcePath = string `/${projectKey}/extensions/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Extension response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyExtensionsByIDPost(string projectKey, string iD, ExtensionUpdate payload, Expansion[]? expand = ()) returns Extension|error { + string resourcePath = string `/${projectKey}/extensions/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Extension response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyExtensionsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns Extension|error { + string resourcePath = string `/${projectKey}/extensions/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Extension response = check self.clientEp->delete(resourcePath); + return response; + } + # Queries carts in a specific Store. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCartsGet(string projectKey, string storeKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns CartPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/carts`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CartPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Creates a cart in the store specified by {storeKey}. + # When using this endpoint the cart's store field is always set to the store specified in the path parameter. + # Creating a cart can fail with an InvalidOperation if the referenced shipping method + # in the CartDraft has a predicate which does not match the cart. + # + # + return - 201 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCartsPost(string projectKey, string storeKey, CartDraft payload, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/carts`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # Retrieves the active cart of the customer that has been modified most recently in a specific Store. + # + # If the cart exists in the commercetools project but does not have the store field, or the store field + # references a different store, this method returns a ResourceNotFound error. + # + # The cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date, + # send an Update request with the Recalculate update action instead. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdGet(string projectKey, string storeKey, string customerId, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/carts/customer-id=${customerId}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->get(resourcePath); + return response; + } + # Returns a cart by its key from a specific Store. + # If the cart exists in the commercetools project but does not have the store field, + # or the store field references a different store, this method returns a ResourceNotFound error. + # The cart may not contain up-to-date prices, discounts etc. + # If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyGet(string projectKey, string storeKey, string 'key, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/carts/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->get(resourcePath); + return response; + } + # Updates a cart in the store specified by {storeKey}. + # If the cart exists in the commercetools project but does not have the store field, + # or the store field references a different store, this method returns a ResourceNotFound error. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyPost(string projectKey, string storeKey, string 'key, CartUpdate payload, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/carts/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyDelete(string projectKey, string storeKey, string 'key, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/carts/key=${'key}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCartsReplicatePost(string projectKey, string storeKey, ReplicaCartDraft payload) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/carts/replicate`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # Returns a cart by its ID from a specific Store. + # If the cart exists in the commercetools project but does not have the store field, + # or the store field references a different store, this method returns a ResourceNotFound error. + # The cart may not contain up-to-date prices, discounts etc. + # If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCartsByIDGet(string projectKey, string storeKey, string iD, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/carts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->get(resourcePath); + return response; + } + # Updates a cart in the store specified by {storeKey}. + # If the cart exists in the commercetools project but does not have the store field, + # or the store field references a different store, this method returns a ResourceNotFound error. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCartsByIDPost(string projectKey, string storeKey, string iD, CartUpdate payload, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/carts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCartsByIDDelete(string projectKey, string storeKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/carts/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersGet(string projectKey, string storeKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns CustomerPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CustomerPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Creates a customer in a specific Store. + # When using this endpoint, if omitted, + # the customer's stores field is set to the store specified in the path parameter. + # If an anonymous cart is passed in as when using this method, + # then the cart is assigned to the created customer and the version number of the Cart increases. + # If the ID of an anonymous session is given, all carts and orders will be assigned to the created customer and + # the store specified. If you pass in a cart with a store field specified, + # the store field must reference the same store specified in the {storeKey} path parameter. + # + # + return - 201 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersPost(string projectKey, string storeKey, CustomerDraft payload, Expansion[]? expand = ()) returns CustomerSignInResult|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerSignInResult response = check self.clientEp->post(resourcePath, request); + return response; + } + # Create a Token for verifying the Customer's Email in store + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenPost(string projectKey, string storeKey, CustomerCreateEmailToken payload) returns CustomerToken|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/email-token`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerToken response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenGet(string projectKey, string storeKey, string emailToken, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/email-token=${emailToken}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->get(resourcePath); + return response; + } + # Verifies customer's email using a token. + # + # + return - The email was verified. + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmPost(string projectKey, string storeKey, CustomerEmailVerify payload) returns Customer|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/email/confirm`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # Returns a customer by its Key from a specific Store. + # It also considers customers that do not have the stores field. + # If the customer exists in the commercetools project but the stores field references different stores, + # this method returns a ResourceNotFound error. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyGet(string projectKey, string storeKey, string 'key, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->get(resourcePath); + return response; + } + # If the customer exists in the commercetools project but the stores field references a different store, + # this method returns a ResourceNotFound error. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost(string projectKey, string storeKey, string 'key, CustomerUpdate payload, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyDelete(string projectKey, string storeKey, string 'key, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/key=${'key}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->delete(resourcePath); + return response; + } + # Change a customers password + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersPasswordPost(string projectKey, string storeKey, CustomerChangePassword payload) returns Customer|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/password`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # The token value is used to reset the password of the customer with the given email. The token is + # valid only for 10 minutes. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenPost(string projectKey, string storeKey, CustomerCreatePasswordResetToken payload) returns CustomerToken|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/password-token`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerToken response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenGet(string projectKey, string storeKey, string passwordToken, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/password-token=${passwordToken}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->get(resourcePath); + return response; + } + # Set a new password using a token. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetPost(string projectKey, string storeKey, CustomerResetPassword payload) returns Customer|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/password/reset`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # Returns a customer by its ID from a specific Store. + # It also considers customers that do not have the stores field. + # If the customer exists in the commercetools project but the stores field references different stores, + # this method returns a ResourceNotFound error. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersByIDGet(string projectKey, string storeKey, string iD, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->get(resourcePath); + return response; + } + # Updates a customer in the store specified by {storeKey}. + # If the customer exists in the commercetools project but the stores field references a different store, + # this method returns a ResourceNotFound error. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersByIDPost(string projectKey, string storeKey, string iD, CustomerUpdate payload, Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyCustomersByIDDelete(string projectKey, string storeKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/customers/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->delete(resourcePath); + return response; + } + # Authenticate Customer (Sign In) in store + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyLoginPost(string projectKey, string storeKey, CustomerSignin payload) returns CustomerSignInResult|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/login`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerSignInResult response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeActiveCartGet(string projectKey, string storeKey) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/active-cart`; + Cart response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeCartsGet(string projectKey, string storeKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns CartPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/carts`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CartPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeCartsPost(string projectKey, string storeKey, MyCartDraft payload, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/carts`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeCartsByIDGet(string projectKey, string storeKey, string iD, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/carts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeCartsByIDPost(string projectKey, string storeKey, string iD, MyCartUpdate payload, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/carts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeCartsByIDDelete(string projectKey, string storeKey, string iD, float 'version, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/carts/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeOrdersGet(string projectKey, string storeKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns OrderPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/orders`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + OrderPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeOrdersPost(string projectKey, string storeKey, MyOrderFromCartDraft payload, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/orders`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Order response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeOrdersByIDGet(string projectKey, string storeKey, string iD, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/orders/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Order response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet(string projectKey, string storeKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ShoppingListPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/shopping-lists`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingListPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeShoppingListsPost(string projectKey, string storeKey, MyShoppingListDraft payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/shopping-lists`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # Gets a shopping list by Key. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet(string projectKey, string storeKey, string 'key, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/shopping-lists/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->get(resourcePath); + return response; + } + # Update a shopping list found by its Key. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyPost(string projectKey, string storeKey, string 'key, MyShoppingListUpdate payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/shopping-lists/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyDelete(string projectKey, string storeKey, string 'key, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/shopping-lists/key=${'key}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->delete(resourcePath); + return response; + } + # Gets a shopping list by ID. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDGet(string projectKey, string storeKey, string iD, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/shopping-lists/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDPost(string projectKey, string storeKey, string iD, MyShoppingListUpdate payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/shopping-lists/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete(string projectKey, string storeKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/me/shopping-lists/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->delete(resourcePath); + return response; + } + # Queries orders in a specific Store. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyOrdersGet(string projectKey, string storeKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns OrderPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/orders`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + OrderPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Creates an order from a Cart from a specific Store. + # When using this endpoint the orders's store field is always set to the store specified in the path parameter. + # The cart must have a shipping address set before creating an order. When using the Platform TaxMode, + # the shipping address is used for tax calculation. + # + # + return - 201 + remote isolated function byProjectKeyInStoreKeyByStoreKeyOrdersPost(string projectKey, string storeKey, OrderFromCartDraft payload, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/orders`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Order response = check self.clientEp->post(resourcePath, request); + return response; + } + # Returns an order by its order number from a specific Store. + # + # If the order exists in the commercetools project but does not have the store field, + # or the store field references a different store, this method returns a ResourceNotFound error. + # In case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+, + # it should be provided in URL-encoded format. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberGet(string projectKey, string storeKey, string orderNumber, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/orders/order-number=${orderNumber}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Order response = check self.clientEp->get(resourcePath); + return response; + } + # Updates an order in the store specified by {storeKey}. + # If the order exists in the commercetools project but does not have the store field, + # or the store field references a different store, this method returns a ResourceNotFound error. + # In case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+, + # it should be provided in URL-encoded format. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberPost(string projectKey, string storeKey, string orderNumber, OrderUpdate payload, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/orders/order-number=${orderNumber}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Order response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberDelete(string projectKey, string storeKey, string orderNumber, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/orders/order-number=${orderNumber}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Order response = check self.clientEp->delete(resourcePath); + return response; + } + # Returns an order by its ID from a specific Store. + # If the order exists in the commercetools project but does not have the store field, + # or the store field references a different store, this method returns a ResourceNotFound error. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyOrdersByIDGet(string projectKey, string storeKey, string iD, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/orders/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Order response = check self.clientEp->get(resourcePath); + return response; + } + # Updates an order in the store specified by {storeKey}. + # If the order exists in the commercetools project but does not have the store field, + # or the store field references a different store, this method returns a ResourceNotFound error. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyOrdersByIDPost(string projectKey, string storeKey, string iD, OrderUpdate payload, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/orders/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Order response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyOrdersByIDDelete(string projectKey, string storeKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/orders/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Order response = check self.clientEp->delete(resourcePath); + return response; + } + # You can use the product projections query endpoint to get the current or staged representations of Products. + # When used with an API client that has the view_published_products:{projectKey} scope, + # this endpoint only returns published (current) product projections. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyProductProjectionsGet(string projectKey, string storeKey, boolean? staged = (), string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ProductProjectionPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/product-projections`; + map queryParam = {"staged": staged, "priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductProjectionPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Gets the current or staged representation of a product by its ID from a specific Store. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet(string projectKey, string storeKey, string 'key, Expansion[]? expand = ()) returns ProductProjection|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/product-projections/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductProjection response = check self.clientEp->get(resourcePath); + return response; + } + # Gets the current or staged representation of a product by its ID from a specific Store. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet(string projectKey, string storeKey, string iD, Expansion[]? expand = ()) returns ProductProjection|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/product-projections/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductProjection response = check self.clientEp->get(resourcePath); + return response; + } + # Queries Product Selection assignments in a specific Store. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsGet(string projectKey, string storeKey) returns ProductsInStorePagedQueryResponse|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/product-selection-assignments`; + ProductsInStorePagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet(string projectKey, string storeKey, string cartId, Expansion[]? expand = ()) returns ShippingMethodPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/shipping-methods/matching-cart`; + map queryParam = {"cartId": cartId, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShippingMethodPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyShoppingListsGet(string projectKey, string storeKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ShoppingListPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/shopping-lists`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingListPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyInStoreKeyByStoreKeyShoppingListsPost(string projectKey, string storeKey, ShoppingListDraft payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/shopping-lists`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # Gets a shopping list by Key. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyGet(string projectKey, string storeKey, string 'key, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/shopping-lists/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->get(resourcePath); + return response; + } + # Update a shopping list found by its Key. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyPost(string projectKey, string storeKey, string 'key, ShoppingListUpdate payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/shopping-lists/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyDelete(string projectKey, string storeKey, string 'key, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/shopping-lists/key=${'key}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->delete(resourcePath); + return response; + } + # Gets a shopping list by ID. + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyShoppingListsByIDGet(string projectKey, string storeKey, string iD, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/shopping-lists/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyShoppingListsByIDPost(string projectKey, string storeKey, string iD, ShoppingListUpdate payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/shopping-lists/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInStoreKeyByStoreKeyShoppingListsByIDDelete(string projectKey, string storeKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/in-store/key=${storeKey}/shopping-lists/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInventoryGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns InventoryPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/inventory`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + InventoryPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyInventoryPost(string projectKey, InventoryEntryDraft payload, Expansion[]? expand = ()) returns InventoryEntry|error { + string resourcePath = string `/${projectKey}/inventory`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + InventoryEntry response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInventoryByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns InventoryEntry|error { + string resourcePath = string `/${projectKey}/inventory/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + InventoryEntry response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInventoryByIDPost(string projectKey, string iD, InventoryEntryUpdate payload, Expansion[]? expand = ()) returns InventoryEntry|error { + string resourcePath = string `/${projectKey}/inventory/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + InventoryEntry response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyInventoryByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns InventoryEntry|error { + string resourcePath = string `/${projectKey}/inventory/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + InventoryEntry response = check self.clientEp->delete(resourcePath); + return response; + } + # Authenticate Customer (Sign In). Retrieves the authenticated + # customer (a customer that matches the given email/password pair). + # If used with an access token for Anonymous Sessions, + # all orders and carts belonging to the anonymousId will be assigned to the newly created customer. + # If a cart is is returned as part of the CustomerSignInResult, + # it has been recalculated (It will have up-to-date prices, taxes and discounts, + # and invalid line items have been removed.). + # + # + return - 200 + remote isolated function byProjectKeyLoginPost(string projectKey, CustomerSignin payload) returns CustomerSignInResult|error { + string resourcePath = string `/${projectKey}/login`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerSignInResult response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeGet(string projectKey, Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), Expansion[]? expand = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns Customer|error { + string resourcePath = string `/${projectKey}/me`; + map queryParam = {"sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "expand": expand, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"sort": {style: FORM, explode: true}, "expand": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Customer response = check self.clientEp->get(resourcePath); + return response; + } + # Update my customer + # + # + return - 200 + remote isolated function byProjectKeyMePost(string projectKey, MyCustomerUpdate payload) returns Customer|error { + string resourcePath = string `/${projectKey}/me`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # Delete my Customer + # + # + return - 200 + remote isolated function byProjectKeyMeDelete(string projectKey, float 'version) returns Customer|error { + string resourcePath = string `/${projectKey}/me`; + map queryParam = {"version": 'version}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam); + Customer response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeActiveCartGet(string projectKey) returns Cart|error { + string resourcePath = string `/${projectKey}/me/active-cart`; + Cart response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeCartsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns CartPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/me/carts`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + CartPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyMeCartsPost(string projectKey, MyCartDraft payload, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/me/carts`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeCartsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/me/carts/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeCartsKeyByKeyPost(string projectKey, string 'key, MyCartUpdate payload, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/me/carts/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeCartsKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/me/carts/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeCartsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/me/carts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeCartsByIDPost(string projectKey, string iD, MyCartUpdate payload, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/me/carts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Cart response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeCartsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns Cart|error { + string resourcePath = string `/${projectKey}/me/carts/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Cart response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - ## Bad Request A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned in the response before re-sending the request. The following general error codes can appear in responses with the HTTP status code `400`: * `InvalidInput` Invalid input has been sent to the service. The client application should validate the input according to the constraints described in the error message before sending the request. * `InvalidOperation` The resource(s) involved in the request are not in a valid state for the operation. The client application should validate the constraints described in the error message before sending the request. * `InvalidField` A field has an invalid value. Extra fields: * `field` - String The name of the field. * `invalidValue` - * The invalid value. * `allowedValues` - Array of * - Optional A fixed set of allowed values for the field, if any. * `RequiredField` A required field is missing a value. Extra fields: * `field` - String The name of the field. * `DuplicateField` A value for a field conflicts with an existing duplicate value. Extra fields: * `field` - String The name of the field. * `duplicateValue` - * The offending duplicate value. + remote isolated function byProjectKeyMeEmailConfirmPost(string projectKey) returns http:Response|error { + string resourcePath = string `/${projectKey}/me/email/confirm`; + http:Request request = new; + //TODO: Update the request as needed; + http:Response response = check self.clientEp-> post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeLoginPost(string projectKey, CustomerSignin payload) returns CustomerSignInResult|error { + string resourcePath = string `/${projectKey}/me/login`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerSignInResult response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeOrdersGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns OrderPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/me/orders`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + OrderPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyMeOrdersPost(string projectKey, MyOrderFromCartDraft payload, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/me/orders`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Order response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeOrdersByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/me/orders/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Order response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMePasswordPost(string projectKey, MyCustomerChangePassword payload) returns Customer|error { + string resourcePath = string `/${projectKey}/me/password`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Customer response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMePasswordResetPost(string projectKey) returns Customer|error { + string resourcePath = string `/${projectKey}/me/password/reset`; + http:Request request = new; + //TODO: Update the request as needed; + Customer response = check self.clientEp-> post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMePaymentsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns MyPaymentPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/me/payments`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + MyPaymentPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyMePaymentsPost(string projectKey, MyPaymentDraft payload, Expansion[]? expand = ()) returns MyPayment|error { + string resourcePath = string `/${projectKey}/me/payments`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + MyPayment response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMePaymentsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns MyPayment|error { + string resourcePath = string `/${projectKey}/me/payments/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + MyPayment response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMePaymentsKeyByKeyPost(string projectKey, string 'key, MyPaymentUpdate payload, Expansion[]? expand = ()) returns MyPayment|error { + string resourcePath = string `/${projectKey}/me/payments/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + MyPayment response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMePaymentsKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns MyPayment|error { + string resourcePath = string `/${projectKey}/me/payments/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + MyPayment response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMePaymentsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns MyPayment|error { + string resourcePath = string `/${projectKey}/me/payments/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + MyPayment response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMePaymentsByIDPost(string projectKey, string iD, MyPaymentUpdate payload, Expansion[]? expand = ()) returns MyPayment|error { + string resourcePath = string `/${projectKey}/me/payments/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + MyPayment response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMePaymentsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns MyPayment|error { + string resourcePath = string `/${projectKey}/me/payments/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + MyPayment response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeShoppingListsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ShoppingListPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/me/shopping-lists`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingListPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyMeShoppingListsPost(string projectKey, MyShoppingListDraft payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/me/shopping-lists`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeShoppingListsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/me/shopping-lists/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeShoppingListsKeyByKeyPost(string projectKey, string 'key, MyShoppingListUpdate payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/me/shopping-lists/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeShoppingListsKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/me/shopping-lists/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeShoppingListsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/me/shopping-lists/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeShoppingListsByIDPost(string projectKey, string iD, MyShoppingListUpdate payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/me/shopping-lists/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMeShoppingListsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/me/shopping-lists/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyMeSignupPost(string projectKey, MyCustomerDraft payload) returns CustomerSignInResult|error { + string resourcePath = string `/${projectKey}/me/signup`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + CustomerSignInResult response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMessagesGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns MessagePagedQueryResponse|error { + string resourcePath = string `/${projectKey}/messages`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + MessagePagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyMessagesByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Message|error { + string resourcePath = string `/${projectKey}/messages/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Message response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns OrderPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/orders`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + OrderPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Creates an order from a Cart. + # The cart must have a shipping address set before creating an order. + # When using the Platform TaxMode, the shipping address is used for tax calculation. + # + # + return - 201 + remote isolated function byProjectKeyOrdersPost(string projectKey, OrderFromCartDraft payload, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/orders`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Order response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersEditsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns OrderEditPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/orders/edits`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + OrderEditPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyOrdersEditsPost(string projectKey, OrderEditDraft payload, Expansion[]? expand = ()) returns OrderEdit|error { + string resourcePath = string `/${projectKey}/orders/edits`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + OrderEdit response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersEditsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns OrderEdit|error { + string resourcePath = string `/${projectKey}/orders/edits/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + OrderEdit response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersEditsKeyByKeyPost(string projectKey, string 'key, OrderEditUpdate payload, Expansion[]? expand = ()) returns OrderEdit|error { + string resourcePath = string `/${projectKey}/orders/edits/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + OrderEdit response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersEditsKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns OrderEdit|error { + string resourcePath = string `/${projectKey}/orders/edits/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + OrderEdit response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersEditsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns OrderEdit|error { + string resourcePath = string `/${projectKey}/orders/edits/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + OrderEdit response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersEditsByIDPost(string projectKey, string iD, OrderEditUpdate payload, Expansion[]? expand = ()) returns OrderEdit|error { + string resourcePath = string `/${projectKey}/orders/edits/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + OrderEdit response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersEditsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns OrderEdit|error { + string resourcePath = string `/${projectKey}/orders/edits/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + OrderEdit response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - ## Bad Request A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned in the response before re-sending the request. The following general error codes can appear in responses with the HTTP status code `400`: * `InvalidInput` Invalid input has been sent to the service. The client application should validate the input according to the constraints described in the error message before sending the request. * `InvalidOperation` The resource(s) involved in the request are not in a valid state for the operation. The client application should validate the constraints described in the error message before sending the request. * `InvalidField` A field has an invalid value. Extra fields: * `field` - String The name of the field. * `invalidValue` - * The invalid value. * `allowedValues` - Array of * - Optional A fixed set of allowed values for the field, if any. * `RequiredField` A required field is missing a value. Extra fields: * `field` - String The name of the field. * `DuplicateField` A value for a field conflicts with an existing duplicate value. Extra fields: * `field` - String The name of the field. * `duplicateValue` - * The offending duplicate value. + remote isolated function byProjectKeyOrdersEditsByIDApplyPost(string projectKey, string iD, OrderEditApply payload) returns http:Response|error { + string resourcePath = string `/${projectKey}/orders/edits/${iD}/apply`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + http:Response response = check self.clientEp->post(resourcePath, request); + return response; + } + # Create an Order by Import + # + # + return - 201 + remote isolated function byProjectKeyOrdersImportPost(string projectKey, OrderImportDraft payload) returns Order|error { + string resourcePath = string `/${projectKey}/orders/import`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Order response = check self.clientEp->post(resourcePath, request); + return response; + } + # In case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+, + # it should be provided in URL-encoded format. + # + # + return - 200 + remote isolated function byProjectKeyOrdersOrderNumberByOrderNumberGet(string projectKey, string orderNumber, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/orders/order-number=${orderNumber}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Order response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersOrderNumberByOrderNumberPost(string projectKey, string orderNumber, OrderUpdate payload, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/orders/order-number=${orderNumber}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Order response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersOrderNumberByOrderNumberDelete(string projectKey, string orderNumber, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/orders/order-number=${orderNumber}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Order response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersSearchPost(string projectKey, OrderSearchRequest payload) returns OrderPagedSearchResponse|error { + string resourcePath = string `/${projectKey}/orders/search`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + OrderPagedSearchResponse response = check self.clientEp->post(resourcePath, request); + return response; + } + # Checks whether a search index for the Project's Orders exists. + # + # + return - The index exists and the Search Orders endpoint can be used. + remote isolated function byProjectKeyOrdersSearchHead(string projectKey) returns http:Response|error { + string resourcePath = string `/${projectKey}/orders/search`; + http:Response response = check self.clientEp->head(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/orders/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Order response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersByIDPost(string projectKey, string iD, OrderUpdate payload, Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/orders/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Order response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyOrdersByIDDelete(string projectKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Order|error { + string resourcePath = string `/${projectKey}/orders/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Order response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyPaymentsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns PaymentPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/payments`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + PaymentPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # To create a payment object a payment draft object has to be given with the request. + # + # + return - 201 + remote isolated function byProjectKeyPaymentsPost(string projectKey, PaymentDraft payload, Expansion[]? expand = ()) returns Payment|error { + string resourcePath = string `/${projectKey}/payments`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Payment response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyPaymentsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns Payment|error { + string resourcePath = string `/${projectKey}/payments/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Payment response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyPaymentsKeyByKeyPost(string projectKey, string 'key, PaymentUpdate payload, Expansion[]? expand = ()) returns Payment|error { + string resourcePath = string `/${projectKey}/payments/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Payment response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyPaymentsKeyByKeyDelete(string projectKey, string 'key, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Payment|error { + string resourcePath = string `/${projectKey}/payments/key=${'key}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Payment response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyPaymentsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Payment|error { + string resourcePath = string `/${projectKey}/payments/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Payment response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyPaymentsByIDPost(string projectKey, string iD, PaymentUpdate payload, Expansion[]? expand = ()) returns Payment|error { + string resourcePath = string `/${projectKey}/payments/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Payment response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyPaymentsByIDDelete(string projectKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Payment|error { + string resourcePath = string `/${projectKey}/payments/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Payment response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductDiscountsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ProductDiscountPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/product-discounts`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductDiscountPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyProductDiscountsPost(string projectKey, ProductDiscountDraft payload, Expansion[]? expand = ()) returns ProductDiscount|error { + string resourcePath = string `/${projectKey}/product-discounts`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ProductDiscount response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductDiscountsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns ProductDiscount|error { + string resourcePath = string `/${projectKey}/product-discounts/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductDiscount response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductDiscountsKeyByKeyPost(string projectKey, string 'key, ProductDiscountUpdate payload, Expansion[]? expand = ()) returns ProductDiscount|error { + string resourcePath = string `/${projectKey}/product-discounts/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ProductDiscount response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductDiscountsKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns ProductDiscount|error { + string resourcePath = string `/${projectKey}/product-discounts/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductDiscount response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductDiscountsMatchingPost(string projectKey, ProductDiscountMatchQuery payload) returns ProductDiscount|error { + string resourcePath = string `/${projectKey}/product-discounts/matching`; + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ProductDiscount response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductDiscountsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns ProductDiscount|error { + string resourcePath = string `/${projectKey}/product-discounts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductDiscount response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductDiscountsByIDPost(string projectKey, string iD, ProductDiscountUpdate payload, Expansion[]? expand = ()) returns ProductDiscount|error { + string resourcePath = string `/${projectKey}/product-discounts/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ProductDiscount response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductDiscountsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns ProductDiscount|error { + string resourcePath = string `/${projectKey}/product-discounts/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductDiscount response = check self.clientEp->delete(resourcePath); + return response; + } + # You can use the product projections query endpoint to get the current or staged representations of Products. + # When used with an API client that has the view_published_products:{projectKey} scope, + # this endpoint only returns published (current) product projections. + # + # + return - 200 + remote isolated function byProjectKeyProductProjectionsGet(string projectKey, boolean? staged = (), string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ProductProjectionPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/product-projections`; + map queryParam = {"staged": staged, "priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductProjectionPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Gets the current or staged representation of a product found by Key. + # When used with an API client that has the view_published_products:{projectKey} scope, + # this endpoint only returns published (current) product projections. + # + # + return - 200 + remote isolated function byProjectKeyProductProjectionsKeyByKeyGet(string projectKey, string 'key, boolean? staged = (), string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = ()) returns ProductProjection|error { + string resourcePath = string `/${projectKey}/product-projections/key=${'key}`; + map queryParam = {"staged": staged, "priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductProjection response = check self.clientEp->get(resourcePath); + return response; + } + # Search Product Projection + # + # + return - 200 + remote isolated function byProjectKeyProductProjectionsSearchGet(string projectKey, boolean? fuzzy = (), float? fuzzyLevel = (), boolean? markMatchingVariants = (), boolean? staged = (), string[]? filter = (), string[]? filterFacets = (), string[]? filterQuery = (), string[]? facet = (), string[]? textAZ2AZ2 = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = ()) returns ProductProjectionPagedSearchResponse|error { + string resourcePath = string `/${projectKey}/product-projections/search`; + map queryParam = {"fuzzy": fuzzy, "fuzzyLevel": fuzzyLevel, "markMatchingVariants": markMatchingVariants, "staged": staged, "filter": filter, "filter.facets": filterFacets, "filter.query": filterQuery, "facet": facet, "/text.[a-z]{2}(-[A-Z]{2})?/": textAZ2AZ2, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "expand": expand}; + map queryParamEncoding = {"filter": {style: FORM, explode: true}, "filter.facets": {style: FORM, explode: true}, "filter.query": {style: FORM, explode: true}, "facet": {style: FORM, explode: true}, "/text.[a-z]{2}(-[A-Z]{2})?/": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductProjectionPagedSearchResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Search Product Projection + # + # + return - 200 + remote isolated function byProjectKeyProductProjectionsSearchPost(string projectKey, URLEncodedPayload payload) returns ProductProjectionPagedSearchResponse|error { + string resourcePath = string `/${projectKey}/product-projections/search`; + http:Request request = new; + string encodedRequestBody = createFormURLEncodedRequestBody(payload); + request.setPayload(encodedRequestBody, "application/x-www-form-urlencoded"); + ProductProjectionPagedSearchResponse response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductProjectionsSuggestGet(string projectKey, boolean? fuzzy = (), boolean? staged = (), string[]? searchkeywordsAZ2AZ2 = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = ()) returns json|error { + string resourcePath = string `/${projectKey}/product-projections/suggest`; + map queryParam = {"fuzzy": fuzzy, "staged": staged, "/searchKeywords.[a-z]{2}(-[A-Z]{2})?/": searchkeywordsAZ2AZ2, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal}; + map queryParamEncoding = {"/searchKeywords.[a-z]{2}(-[A-Z]{2})?/": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + json response = check self.clientEp->get(resourcePath); + return response; + } + # Gets the current or staged representation of a product in a catalog by ID. + # When used with an API client that has the view_published_products:{projectKey} scope, + # this endpoint only returns published (current) product projections. + # + # + return - 200 + remote isolated function byProjectKeyProductProjectionsByIDGet(string projectKey, string iD, boolean? staged = (), string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = ()) returns ProductProjection|error { + string resourcePath = string `/${projectKey}/product-projections/${iD}`; + map queryParam = {"staged": staged, "priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductProjection response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductSelectionsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ProductSelectionPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/product-selections`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductSelectionPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyProductSelectionsPost(string projectKey, ProductSelectionDraft payload, Expansion[]? expand = ()) returns ProductSelection|error { + string resourcePath = string `/${projectKey}/product-selections`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ProductSelection response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductSelectionsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns ProductSelection|error { + string resourcePath = string `/${projectKey}/product-selections/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductSelection response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductSelectionsKeyByKeyPost(string projectKey, string 'key, ProductSelectionUpdate payload, Expansion[]? expand = ()) returns ProductSelection|error { + string resourcePath = string `/${projectKey}/product-selections/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ProductSelection response = check self.clientEp->post(resourcePath, request); + return response; + } + # Deletion will only succeed if the Product Selection is not assigned to any [Store](/../api/projects/stores#store). + # + # + return - 200 + remote isolated function byProjectKeyProductSelectionsKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns ProductSelection|error { + string resourcePath = string `/${projectKey}/product-selections/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductSelection response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductSelectionsKeyByKeyProductsGet(string projectKey, string 'key, Expansion[]? expand = (), float? 'limit = (), float? offset = (), boolean? withTotal = ()) returns ProductSelectionProductPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/product-selections/key=${'key}/products`; + map queryParam = {"expand": expand, "limit": 'limit, "offset": offset, "withTotal": withTotal}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductSelectionProductPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductSelectionsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns ProductSelection|error { + string resourcePath = string `/${projectKey}/product-selections/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductSelection response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductSelectionsByIDPost(string projectKey, string iD, ProductSelectionUpdate payload, Expansion[]? expand = ()) returns ProductSelection|error { + string resourcePath = string `/${projectKey}/product-selections/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ProductSelection response = check self.clientEp->post(resourcePath, request); + return response; + } + # Deletion will only succeed if the Product Selection is not assigned to any [Store](/../api/projects/stores#store). + # + # + return - 200 + remote isolated function byProjectKeyProductSelectionsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns ProductSelection|error { + string resourcePath = string `/${projectKey}/product-selections/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductSelection response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductSelectionsByIDProductsGet(string projectKey, string iD, Expansion[]? expand = (), float? 'limit = (), float? offset = (), boolean? withTotal = ()) returns ProductSelectionProductPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/product-selections/${iD}/products`; + map queryParam = {"expand": expand, "limit": 'limit, "offset": offset, "withTotal": withTotal}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductSelectionProductPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductTypesGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ProductTypePagedQueryResponse|error { + string resourcePath = string `/${projectKey}/product-types`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductTypePagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyProductTypesPost(string projectKey, ProductTypeDraft payload, Expansion[]? expand = ()) returns ProductType|error { + string resourcePath = string `/${projectKey}/product-types`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ProductType response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductTypesKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns ProductType|error { + string resourcePath = string `/${projectKey}/product-types/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductType response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductTypesKeyByKeyPost(string projectKey, string 'key, ProductTypeUpdate payload, Expansion[]? expand = ()) returns ProductType|error { + string resourcePath = string `/${projectKey}/product-types/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ProductType response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductTypesKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns ProductType|error { + string resourcePath = string `/${projectKey}/product-types/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductType response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductTypesByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns ProductType|error { + string resourcePath = string `/${projectKey}/product-types/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductType response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductTypesByIDPost(string projectKey, string iD, ProductTypeUpdate payload, Expansion[]? expand = ()) returns ProductType|error { + string resourcePath = string `/${projectKey}/product-types/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ProductType response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductTypesByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns ProductType|error { + string resourcePath = string `/${projectKey}/product-types/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductType response = check self.clientEp->delete(resourcePath); + return response; + } + # You can use the query endpoint to get the full representations of products. + # REMARK: We suggest to use the performance optimized search endpoint which has a bunch functionalities, + # the query API lacks like sorting on custom attributes, etc. + # + # + return - 200 + remote isolated function byProjectKeyProductsGet(string projectKey, string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ProductPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/products`; + map queryParam = {"priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # To create a new product, send a representation that is going to become the initial staged representation + # of the new product in the master catalog. If price selection query parameters are provided, + # the selected prices will be added to the response. + # + # + return - 201 + remote isolated function byProjectKeyProductsPost(string projectKey, ProductDraft payload, string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = ()) returns Product|error { + string resourcePath = string `/${projectKey}/products`; + map queryParam = {"priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Product response = check self.clientEp->post(resourcePath, request); + return response; + } + # Checks if products exist. + # + # + return - At least one Product matching the query exists + remote isolated function byProjectKeyProductsHead(string projectKey) returns http:Response|error { + string resourcePath = string `/${projectKey}/products`; + http:Response response = check self.clientEp->head(resourcePath); + return response; + } + # Gets the full representation of a product by Key. + # + # + return - 200 + remote isolated function byProjectKeyProductsKeyByKeyGet(string projectKey, string 'key, string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = ()) returns Product|error { + string resourcePath = string `/${projectKey}/products/key=${'key}`; + map queryParam = {"priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Product response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductsKeyByKeyPost(string projectKey, string 'key, ProductUpdate payload, string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = ()) returns Product|error { + string resourcePath = string `/${projectKey}/products/key=${'key}`; + map queryParam = {"priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Product response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductsKeyByKeyDelete(string projectKey, string 'key, float 'version, string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = ()) returns Product|error { + string resourcePath = string `/${projectKey}/products/key=${'key}`; + map queryParam = {"priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Product response = check self.clientEp->delete(resourcePath); + return response; + } + # Checks if product with given key exists. + # + # + return - The Product exists + remote isolated function byProjectKeyProductsKeyByKeyHead(string projectKey, string 'key) returns http:Response|error { + string resourcePath = string `/${projectKey}/products/key=${'key}`; + http:Response response = check self.clientEp->head(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductsKeyByKeyProductSelectionsGet(string projectKey, string 'key, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ProductSelectionPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/products/key=${'key}/product-selections`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductSelectionPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # Gets the full representation of a product by ID. + # + # + return - 200 + remote isolated function byProjectKeyProductsByIDGet(string projectKey, string iD, string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = ()) returns Product|error { + string resourcePath = string `/${projectKey}/products/${iD}`; + map queryParam = {"priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Product response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductsByIDPost(string projectKey, string iD, ProductUpdate payload, string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = ()) returns Product|error { + string resourcePath = string `/${projectKey}/products/${iD}`; + map queryParam = {"priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Product response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductsByIDDelete(string projectKey, string iD, float 'version, string? priceCurrency = (), string? priceCountry = (), string? priceCustomerGroup = (), string? priceChannel = (), string? localeProjection = (), string? storeProjection = (), Expansion[]? expand = ()) returns Product|error { + string resourcePath = string `/${projectKey}/products/${iD}`; + map queryParam = {"priceCurrency": priceCurrency, "priceCountry": priceCountry, "priceCustomerGroup": priceCustomerGroup, "priceChannel": priceChannel, "localeProjection": localeProjection, "storeProjection": storeProjection, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Product response = check self.clientEp->delete(resourcePath); + return response; + } + # Checks if product with given ID exists. + # + # + return - The Product exists + remote isolated function byProjectKeyProductsByIDHead(string projectKey, string iD) returns http:Response|error { + string resourcePath = string `/${projectKey}/products/${iD}`; + http:Response response = check self.clientEp->head(resourcePath); + return response; + } + # Uploads a binary image file to a given product variant. The supported image formats are JPEG, PNG and GIF. + # + # + return - 200 + remote isolated function byProjectKeyProductsByIDImagesPost(string projectKey, string iD, byte[] payload, string? filename = (), float? variant = (), string? sku = (), boolean? staged = ()) returns Product|error { + string resourcePath = string `/${projectKey}/products/${iD}/images`; + map queryParam = {"filename": filename, "variant": variant, "sku": sku, "staged": staged}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam); + http:Request request = new; + request.setPayload(payload, "application/octet-stream"); + Product response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyProductsByIDProductSelectionsGet(string projectKey, string iD, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ProductSelectionPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/products/${iD}/product-selections`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ProductSelectionPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyReviewsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ReviewPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/reviews`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ReviewPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyReviewsPost(string projectKey, ReviewDraft payload, Expansion[]? expand = ()) returns Review|error { + string resourcePath = string `/${projectKey}/reviews`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Review response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyReviewsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns Review|error { + string resourcePath = string `/${projectKey}/reviews/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Review response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyReviewsKeyByKeyPost(string projectKey, string 'key, ReviewUpdate payload, Expansion[]? expand = ()) returns Review|error { + string resourcePath = string `/${projectKey}/reviews/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Review response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyReviewsKeyByKeyDelete(string projectKey, string 'key, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Review|error { + string resourcePath = string `/${projectKey}/reviews/key=${'key}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Review response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyReviewsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Review|error { + string resourcePath = string `/${projectKey}/reviews/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Review response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyReviewsByIDPost(string projectKey, string iD, ReviewUpdate payload, Expansion[]? expand = ()) returns Review|error { + string resourcePath = string `/${projectKey}/reviews/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Review response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyReviewsByIDDelete(string projectKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns Review|error { + string resourcePath = string `/${projectKey}/reviews/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Review response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShippingMethodsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ShippingMethodPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/shipping-methods`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShippingMethodPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyShippingMethodsPost(string projectKey, ShippingMethodDraft payload, Expansion[]? expand = ()) returns ShippingMethod|error { + string resourcePath = string `/${projectKey}/shipping-methods`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShippingMethod response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShippingMethodsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns ShippingMethod|error { + string resourcePath = string `/${projectKey}/shipping-methods/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShippingMethod response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShippingMethodsKeyByKeyPost(string projectKey, string 'key, ShippingMethodUpdate payload, Expansion[]? expand = ()) returns ShippingMethod|error { + string resourcePath = string `/${projectKey}/shipping-methods/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShippingMethod response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShippingMethodsKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns ShippingMethod|error { + string resourcePath = string `/${projectKey}/shipping-methods/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShippingMethod response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShippingMethodsMatchingCartGet(string projectKey, string cartId, Expansion[]? expand = ()) returns ShippingMethodPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/shipping-methods/matching-cart`; + map queryParam = {"cartId": cartId, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShippingMethodPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShippingMethodsMatchingLocationGet(string projectKey, string country, string? state = (), string? currency = (), Expansion[]? expand = ()) returns ShippingMethodPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/shipping-methods/matching-location`; + map queryParam = {"country": country, "state": state, "currency": currency, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShippingMethodPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShippingMethodsMatchingOrdereditGet(string projectKey, string orderEditId, string country, string? state = ()) returns ShippingMethodPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/shipping-methods/matching-orderedit`; + map queryParam = {"orderEditId": orderEditId, "country": country, "state": state}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam); + ShippingMethodPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShippingMethodsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns ShippingMethod|error { + string resourcePath = string `/${projectKey}/shipping-methods/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShippingMethod response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShippingMethodsByIDPost(string projectKey, string iD, ShippingMethodUpdate payload, Expansion[]? expand = ()) returns ShippingMethod|error { + string resourcePath = string `/${projectKey}/shipping-methods/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShippingMethod response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShippingMethodsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns ShippingMethod|error { + string resourcePath = string `/${projectKey}/shipping-methods/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShippingMethod response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShoppingListsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ShoppingListPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/shopping-lists`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingListPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyShoppingListsPost(string projectKey, ShoppingListDraft payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/shopping-lists`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # Gets a shopping list by Key. + # + # + return - 200 + remote isolated function byProjectKeyShoppingListsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/shopping-lists/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->get(resourcePath); + return response; + } + # Update a shopping list found by its Key. + # + # + return - 200 + remote isolated function byProjectKeyShoppingListsKeyByKeyPost(string projectKey, string 'key, ShoppingListUpdate payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/shopping-lists/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShoppingListsKeyByKeyDelete(string projectKey, string 'key, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/shopping-lists/key=${'key}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->delete(resourcePath); + return response; + } + # Gets a shopping list by ID. + # + # + return - 200 + remote isolated function byProjectKeyShoppingListsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/shopping-lists/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShoppingListsByIDPost(string projectKey, string iD, ShoppingListUpdate payload, Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/shopping-lists/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + ShoppingList response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyShoppingListsByIDDelete(string projectKey, string iD, float 'version, boolean? dataErasure = (), Expansion[]? expand = ()) returns ShoppingList|error { + string resourcePath = string `/${projectKey}/shopping-lists/${iD}`; + map queryParam = {"dataErasure": dataErasure, "version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ShoppingList response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStatesGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns StatePagedQueryResponse|error { + string resourcePath = string `/${projectKey}/states`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + StatePagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyStatesPost(string projectKey, StateDraft payload, Expansion[]? expand = ()) returns State|error { + string resourcePath = string `/${projectKey}/states`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + State response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStatesKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns State|error { + string resourcePath = string `/${projectKey}/states/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + State response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStatesKeyByKeyPost(string projectKey, string 'key, StateUpdate payload, Expansion[]? expand = ()) returns State|error { + string resourcePath = string `/${projectKey}/states/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + State response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStatesKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns State|error { + string resourcePath = string `/${projectKey}/states/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + State response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStatesByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns State|error { + string resourcePath = string `/${projectKey}/states/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + State response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStatesByIDPost(string projectKey, string iD, StateUpdate payload, Expansion[]? expand = ()) returns State|error { + string resourcePath = string `/${projectKey}/states/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + State response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStatesByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns State|error { + string resourcePath = string `/${projectKey}/states/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + State response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStoresGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns StorePagedQueryResponse|error { + string resourcePath = string `/${projectKey}/stores`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + StorePagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyStoresPost(string projectKey, StoreDraft payload, Expansion[]? expand = ()) returns Store|error { + string resourcePath = string `/${projectKey}/stores`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Store response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStoresKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns Store|error { + string resourcePath = string `/${projectKey}/stores/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Store response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStoresKeyByKeyPost(string projectKey, string 'key, StoreUpdate payload, Expansion[]? expand = ()) returns Store|error { + string resourcePath = string `/${projectKey}/stores/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Store response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStoresKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns Store|error { + string resourcePath = string `/${projectKey}/stores/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Store response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStoresByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Store|error { + string resourcePath = string `/${projectKey}/stores/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Store response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStoresByIDPost(string projectKey, string iD, StoreUpdate payload, Expansion[]? expand = ()) returns Store|error { + string resourcePath = string `/${projectKey}/stores/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Store response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyStoresByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns Store|error { + string resourcePath = string `/${projectKey}/stores/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Store response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeySubscriptionsGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns SubscriptionPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/subscriptions`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + SubscriptionPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # The creation of a Subscription is eventually consistent, it may take up to a minute before it becomes fully active. + # In order to test that the destination is correctly configured, a test message will be put into the queue. + # If the message could not be delivered, the subscription will not be created. + # The payload of the test message is a notification of type ResourceCreated for the resourceTypeId subscription. + # Currently, a maximum of 25 subscriptions can be created per project. + # + # + return - 201 + remote isolated function byProjectKeySubscriptionsPost(string projectKey, SubscriptionDraft payload, Expansion[]? expand = ()) returns Subscription|error { + string resourcePath = string `/${projectKey}/subscriptions`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Subscription response = check self.clientEp->post(resourcePath, request); + return response; + } + # Retrieves the representation of a subscription by its key. + # + # + return - 200 + remote isolated function byProjectKeySubscriptionsKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns Subscription|error { + string resourcePath = string `/${projectKey}/subscriptions/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Subscription response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeySubscriptionsKeyByKeyPost(string projectKey, string 'key, SubscriptionUpdate payload, Expansion[]? expand = ()) returns Subscription|error { + string resourcePath = string `/${projectKey}/subscriptions/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Subscription response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeySubscriptionsKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns Subscription|error { + string resourcePath = string `/${projectKey}/subscriptions/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Subscription response = check self.clientEp->delete(resourcePath); + return response; + } + # Retrieves the representation of a subscription by its id. + # + # + return - 200 + remote isolated function byProjectKeySubscriptionsByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Subscription|error { + string resourcePath = string `/${projectKey}/subscriptions/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Subscription response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeySubscriptionsByIDPost(string projectKey, string iD, SubscriptionUpdate payload, Expansion[]? expand = ()) returns Subscription|error { + string resourcePath = string `/${projectKey}/subscriptions/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Subscription response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeySubscriptionsByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns Subscription|error { + string resourcePath = string `/${projectKey}/subscriptions/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Subscription response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTaxCategoriesGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns TaxCategoryPagedQueryResponse|error { + string resourcePath = string `/${projectKey}/tax-categories`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + TaxCategoryPagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyTaxCategoriesPost(string projectKey, TaxCategoryDraft payload, Expansion[]? expand = ()) returns TaxCategory|error { + string resourcePath = string `/${projectKey}/tax-categories`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + TaxCategory response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTaxCategoriesKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns TaxCategory|error { + string resourcePath = string `/${projectKey}/tax-categories/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + TaxCategory response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTaxCategoriesKeyByKeyPost(string projectKey, string 'key, TaxCategoryUpdate payload, Expansion[]? expand = ()) returns TaxCategory|error { + string resourcePath = string `/${projectKey}/tax-categories/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + TaxCategory response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTaxCategoriesKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns TaxCategory|error { + string resourcePath = string `/${projectKey}/tax-categories/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + TaxCategory response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTaxCategoriesByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns TaxCategory|error { + string resourcePath = string `/${projectKey}/tax-categories/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + TaxCategory response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTaxCategoriesByIDPost(string projectKey, string iD, TaxCategoryUpdate payload, Expansion[]? expand = ()) returns TaxCategory|error { + string resourcePath = string `/${projectKey}/tax-categories/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + TaxCategory response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTaxCategoriesByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns TaxCategory|error { + string resourcePath = string `/${projectKey}/tax-categories/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + TaxCategory response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTypesGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns TypePagedQueryResponse|error { + string resourcePath = string `/${projectKey}/types`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + TypePagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyTypesPost(string projectKey, TypeDraft payload, Expansion[]? expand = ()) returns Type|error { + string resourcePath = string `/${projectKey}/types`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Type response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTypesKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns Type|error { + string resourcePath = string `/${projectKey}/types/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Type response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTypesKeyByKeyPost(string projectKey, string 'key, TypeUpdate payload, Expansion[]? expand = ()) returns Type|error { + string resourcePath = string `/${projectKey}/types/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Type response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTypesKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns Type|error { + string resourcePath = string `/${projectKey}/types/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Type response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTypesByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Type|error { + string resourcePath = string `/${projectKey}/types/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Type response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTypesByIDPost(string projectKey, string iD, TypeUpdate payload, Expansion[]? expand = ()) returns Type|error { + string resourcePath = string `/${projectKey}/types/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Type response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyTypesByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns Type|error { + string resourcePath = string `/${projectKey}/types/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Type response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyZonesGet(string projectKey, Expansion[]? expand = (), Sort[]? sort = (), float? 'limit = (), float? offset = (), boolean? withTotal = (), QueryPredicate[]? 'where = (), string[]? varAZaZ09 = ()) returns ZonePagedQueryResponse|error { + string resourcePath = string `/${projectKey}/zones`; + map queryParam = {"expand": expand, "sort": sort, "limit": 'limit, "offset": offset, "withTotal": withTotal, "where": 'where, "/^var[.][a-zA-Z0-9]+$/": varAZaZ09}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}, "sort": {style: FORM, explode: true}, "where": {style: FORM, explode: true}, "/^var[.][a-zA-Z0-9]+$/": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + ZonePagedQueryResponse response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 201 + remote isolated function byProjectKeyZonesPost(string projectKey, ZoneDraft payload, Expansion[]? expand = ()) returns Zone|error { + string resourcePath = string `/${projectKey}/zones`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Zone response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyZonesKeyByKeyGet(string projectKey, string 'key, Expansion[]? expand = ()) returns Zone|error { + string resourcePath = string `/${projectKey}/zones/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Zone response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyZonesKeyByKeyPost(string projectKey, string 'key, ZoneUpdate payload, Expansion[]? expand = ()) returns Zone|error { + string resourcePath = string `/${projectKey}/zones/key=${'key}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Zone response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyZonesKeyByKeyDelete(string projectKey, string 'key, float 'version, Expansion[]? expand = ()) returns Zone|error { + string resourcePath = string `/${projectKey}/zones/key=${'key}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Zone response = check self.clientEp->delete(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyZonesByIDGet(string projectKey, string iD, Expansion[]? expand = ()) returns Zone|error { + string resourcePath = string `/${projectKey}/zones/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Zone response = check self.clientEp->get(resourcePath); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyZonesByIDPost(string projectKey, string iD, ZoneUpdate payload, Expansion[]? expand = ()) returns Zone|error { + string resourcePath = string `/${projectKey}/zones/${iD}`; + map queryParam = {"expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + http:Request request = new; + json jsonBody = check payload.cloneWithType(json); + request.setPayload(jsonBody, "application/json"); + Zone response = check self.clientEp->post(resourcePath, request); + return response; + } + # + # + return - 200 + remote isolated function byProjectKeyZonesByIDDelete(string projectKey, string iD, float 'version, Expansion[]? expand = ()) returns Zone|error { + string resourcePath = string `/${projectKey}/zones/${iD}`; + map queryParam = {"version": 'version, "expand": expand}; + map queryParamEncoding = {"expand": {style: FORM, explode: true}}; + resourcePath = resourcePath + check getPathForQueryParam(queryParam, queryParamEncoding); + Zone response = check self.clientEp->delete(resourcePath); + return response; + } +} diff --git a/openapi/commercetools/icon.png b/openapi/commercetools/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..49bfe26eeb856a2b01165101503fb24c59da24ce GIT binary patch literal 5725 zcmd6rcUM#0x9^h>AQ6Gkm1gL@h$2B+P^1VXAiaqoAW`W`ks7-6B3(Mtq#QX*0! zB@`75(xgQU(gmcRJil?qz2n|DaLyQOuDSM{-!=Ezf9$cw{JbOQ6IFNE%jUs4FQtWH3R^R!2rPjN~p$7H2{F7 z2ne8|df>mYBGCWI5{hX4@A_Y1o{d@t0KhSzr=@A?5B#0a@Qi&bV4#~tw@B<(nEzc! z@8|xGi*!y;iCz$3=E~ewGFm1Kh(Xw9L zk3}X>TV4s*r*E%WZBB$|1Q~W#aS-Mjq0gesP3nE+=pB_A1k5_Keh5M$VPlA|v^cj{ ztlx$uHr%Xjt$Dn4X6(O0v?9k#)rQ)7Bc$VAwFXDfYvLt=i7%8N1!PQsC}xnpTqM)e z!8gtL^w%~gj0{4vkH2lHLd1oNjK#>3a>hyfydyT>S?k|#Gc1=X$le{7l1}LGw@)G? z@xCB#MV}lOJ{g%{l>)y$3*PC5HHo@MPooiwnn{m%Mc|)%B;ox~jqWg4 zgD^P^VaqkYWt0FGX0(^1&3Q5Q8d;Y$Z&afY#jX?(hNp3%2-9#i>`h8mrO?xLP0=_l z+<}cjUAYgw(QfcnK9_n?k`_Bl0MTHq#23NQ(C{i>}j>wUoNG2gWT<2HcQ$Fi84-A_yo617P7mh;S@O z4E{hEfW4HnZ~+2_BH^0s2p~`h2%whe9q@lvhDMk zzKL?pL1ONM^LW*x=*_RZCck`^)YrZbv9j%6rF(0M7GGKmK}o0CATTl(fvzS?$}dWb zGu1o3AuR&P92HMTVjFOOS4B{rM4!!Z-wx-I(V@E@W07R<6tj;ypO@ImC&+=-U1bQ^TM4OXo*dDAZ0K@1VJ`NE$efYsNH)E|%O?!YzuOd{U zJ*Pl6TeIF4VK{1jULfmfN4Lrhs`Kcx9(*1b_cs(-PqbXP>9vOjt=X=fPqsSV^!h%F z>++;?_IwB!J_g%LrFhM-{y9pB!uf0{3{Wnamng>D5V}mBvGH~N@xcXs)0IN~u;PMw zzCoIk6W^fSJLAuUyYaNKi@QB#dj?0p*HwPLStMOI^$}S;1Z6s*+ay@$qVH zk=148jeYT;NAQIU*kRq#61CmT&nN3Y=$MaIdbBnoUugg^<lM>p zzR-}C*B`3(?BCt}Y4cF*Sgo=PYJclk^R6ZD=6s{+6`mEI5*n}*Y)U^w;koQ{`nvJx z-LEt=iG^&2a0g`q@5WYO%(8^v%qL*zx>|l;r2#{S_Pawu1K)cn zkBhRJuTPFs7!~(Wp96j^ZkijcCcSF3zruaZc#|V5gi&SPD3C$s(5|htG<+m_soM(w zcBenPbJlZSDfvoK76o;=?*0BPL7m+*8NXbT08`F7u6W~mr;!cjsPLNs*v`c-)HqaI zLv*L8SB#X# zM&B}BR$dvHKfGh(R}*f|H}?kpQjx=&R*7$Q@N^KZQKF&No?KQ?I#^b>yCmUbs!Z?4 z&SI41SnB^%uFbMB_E^=F^ocn1qHmwfMXdBzaPbT2dk5v>6R#Ld(!Z*~vxb%1dir4^ zbxH6vfdYj;c#qWfHrY4`xRolIzDjx%)BIWBzJb8FZ)9IX${oQzRkMA&s2bD15;?OC zcJOojJ3vfD_1Y$)=WT+t3huW3^InNwOHM(sWM?R6F7SVTjp*5;bGjW zZ-3$J-z(-MS=>4k?>{K~4eZRwF8>b4MKKa-S{Ge- zH2gxB&s)>FW$v*m&(!xal0T)70e7~?GTr|pTBHDZ67iI7>zL-kYC65Y=Z}Xc$?MBK zPieqIUq;adss>MV5=ybr@k!Q0i5Kw{3>=)oz&T zQW{xTVxl7NJ&P9=e^rC8Mrtx93(g5RE&yK%#+A+(yk3XOn>VB8J>rpN{uvkta3wNj zX6gG^o&43}^un<2UukS5j5EcZeMMgp$6Qt zQ=Gn{{neGB;`I>(BAWWky&$M#<^5nt7JV;O_HD^a<_0&$BC%mM5b;sXnxwgmd>4le zfv}sgi>)aRqUJUHpoVbfQAyDvRr-dTy=4U!H~%C428TUSj!p24YKs9#uEi}aax*L7 z92+l-4y%D{`pN@)SnAQQ$ndOyPD!cg+QFK!kMF9X|89z}(u7x+UfQq{D7p{tD5&M& zi5iiuUHJGe4l2$?=zBYvx$+6Ud$!RWw&q1S7g49nE zObI3urcsSc=^W{5pcpCZ#xHRiThjHi>B}%`(b*2Ug>!4$UaRu;vsA<5OQHcm1H3`Y z@T)>Rhd?X#k!m$NM7~q7y`>`*PTzn%Z|05<%}vu9F`rS)C& zH>WBJ#Iv;NNZbZZK~57DczIil0ZbE#gmg%`h8fIvxSmDo`>@AtgTW&ZC8Jz ziYNXi@H<%We&9-wqMZ>gVN}Wg;ZXg`dq11T;@2PDx&ojambUx4t({-}lVo?w-?;zd zRA2U85+-rGn{ez@*_c%^vgBpG!4oZbs_3jFSI*H^`U?C!BA#0$tuxL2EmFAYji)s73h7@o5DpHJ^d3SJzk_3m>@G#-!pYhm(&6O@#{hz;D7ZcDSo?7spU#Uy< zRS_-9=9r1ge$Rf~ZJ+;uO>FUspGLVypNhm^8(LIPIJF{p>oH#|b*g7Sc(fSpGXNG; z>Anjxa(n16x3AR7w6#66g1hMTOGWg4dyI@R z^IhK+z6i6H*?%c4cJBBp*rht&XY_yDCvS$&*9IP5jgl0#0ZhwML(s&+3B-iocjbb zhGm*GS;_nz@quh+_gnb8)ZUfdSN(>#2^%>!Tz@0nePmFCq>W-CQMBF#5Kf(Ced|u2 z%IQ6%8x98Za>WW01DQ5U>}*YQDvL~HxF_`1a)bw_ZbgqAcn5Sxur0%7Q$)P0Osf1& zw#S1_KfIH7*bt`P?q#7{qdVP)gJ|D-ohA48&)oBr(LZc8CBMC7k2&0BAsWtO)IIu# zpzp;27cwgMl8pyj6Wy^or%c8}I+Cuggr716Vb!l0W# z_a>_lSNeRk5h@M7y64d}uvTa!fo4C;p35`B#-i^Ci_o{M)uONdorzEys_E&jKH*af z*)bX2^DBy736B&_FTTscjlZ02IkWB!*PHRU@trWl)W zKat8+mR=JJtu$OI5eR_tq(w()LxIcYc}fV8t*#?C@A{TY*#X~Q%T2Q9&~k<467Yac zq$7=Ag4Ido=ktu?KP8_AI>N9P2AuZ(sWw$ErX6UH9dVcJ7ARsaonK1Uiu(~XYku>J zVnIQ+e41qtO!S+l7GI8viX+o^njSb*GF3< zHPoPimZA^k%V_JzO))a+o?CKmPP)rneBf(=1t@k;$CyYt8#G1;+u1K1sS~X@w|_;U z;_lF0>Y6nj2(Nu}j_E=+K4`I*A=xw}B(i@WQXMD@>)VOxICF#6+gkR-Hy9d@-pjqO z67Ym_`n&Pz&p&r&_l3tx+~fa_KEg!>3o$pfOkntlo0o0OUqpzyAC}PfM1Y`C8j^~M ztGoX^CvAGBg*c^1Ka`}HJMW}^*qvT^m#(vS!;7UV>i9v~o2n>gQlu#{@9(aqjtbvu zK?up5*d3rH-YI;}F9;juXc*SArx80kXsxtI9 zZeIi+NJ5ZsN%0=Wd1_l5#M1=HzCdkwFT{C%Y@s%>^V%|?@^ApSBwTQ2ONQD#w;0EV zRsAn3fft7*z6j#6244i1u>1!DKwYy++OYFTd<(dzEVvYjL%#I@!XLn4iDB9@#Tq=c ztYg);JbL_Kx~!n+fAIn*B2!o%W&nc-6kVPOxr8lSX9~DruL)O%xZ=dF7inY59(C$- z+d(^7<~8wCVBrz{Y38e?NY0w4Z^D{omeqr3fuU?E*X1x8y$PUHo_nCY+Z!J(U|UL9 z2u8gFd2h{4*2Q7|Zm1YEvMxES?77~qgLDUyGi#C+Qy<-SB@2m<0V8TDn7K>1El}z) zm1!w+tzB2AGKB>pDx?vq)%k}2V!1<$%Mw(L8G`LzeH@BPyS=JEw+_BXzoLQD#c#ZVQC+Ctckx0ns_BuYbGkW{Nu!_E0*I3 z*CDU+CflYpB#i&S2ys~82|5yoq4LtSm)K(>1Q&30@mslNjILR65(W8V)5jFAbK&zI!nX9Q8 zeokI2RvMa15{n9K^21JIChm)({~s)cd9q;7X+Zr|Rc_otjQ^rty*ntax?2yz{|iuX Bf}{Wd literal 0 HcmV?d00001 diff --git a/openapi/commercetools/openapi.yml b/openapi/commercetools/openapi.yml new file mode 100644 index 000000000..65a5bbfdf --- /dev/null +++ b/openapi/commercetools/openapi.yml @@ -0,0 +1,81946 @@ +openapi: 3.0.0 +info: + title: Commercetools + version: v1 + description: >- + This is a generated connector for [Commercetools API v1](https://docs.commercetools.com/api/) OpenAPI specification. + + The commercetools Platform HTTP API offers an interface for programmatic access to the data stored on the platform and associated functionality. + x-ballerina-init-description: > + The connector initialization requires setting the API credentials. + Create and configure an OAuth2 client credentials by following [this guide](https://docs.commercetools.com/api/authorization). + x-ballerina-display: + label: Commercetools + iconPath: "icon.png" + +security: + - bearerAuth: [] +paths: + /{projectKey}: + description: |- + The Project endpoint is used to retrieve certain information from a project. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + security: + - oauth_2_0: + - "manage_project:{projectKey}" + operationId: ByProjectKeyGet + description: |- + The Endpoint is responding a limited set of information about settings and configuration of the project. + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Project' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + security: + - oauth_2_0: + - "manage_project:{projectKey}" + operationId: ByProjectKeyPost + description: |- + Update project + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Project' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/api-clients: + description: |- + Manage your API Clients via an API. Useful for Infrastructure-as-Code tooling, and regularly rotating API secrets. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "api-clients" + security: + - oauth_2_0: + - "view_api_clients:{projectKey}" + operationId: ByProjectKeyApiClientsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClientPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "api-clients" + security: + - oauth_2_0: + - "manage_api_clients:{projectKey}" + operationId: ByProjectKeyApiClientsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClientDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClient' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/api-clients/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "api-clients" + - "ID" + security: + - oauth_2_0: + - "view_api_clients:{projectKey}" + operationId: ByProjectKeyApiClientsByIDGet + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClient' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "api-clients" + - "ID" + security: + - oauth_2_0: + - "manage_api_clients:{projectKey}" + operationId: ByProjectKeyApiClientsByIDDelete + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClient' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/cart-discounts: + description: |- + Cart discounts are used to change the prices of different elements within a cart. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "cart-discounts" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_cart_discounts:{projectKey}" + operationId: ByProjectKeyCartDiscountsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CartDiscountPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "cart-discounts" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_cart_discounts:{projectKey}" + operationId: ByProjectKeyCartDiscountsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CartDiscountDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/CartDiscount' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/cart-discounts/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "cart-discounts" + - "key=key" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_cart_discounts:{projectKey}" + operationId: ByProjectKeyCartDiscountsKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CartDiscount' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "cart-discounts" + - "key=key" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_cart_discounts:{projectKey}" + operationId: ByProjectKeyCartDiscountsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CartDiscountUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CartDiscount' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "cart-discounts" + - "key=key" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_cart_discounts:{projectKey}" + operationId: ByProjectKeyCartDiscountsKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CartDiscount' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/cart-discounts/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "cart-discounts" + - "ID" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_cart_discounts:{projectKey}" + operationId: ByProjectKeyCartDiscountsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CartDiscount' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "cart-discounts" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_cart_discounts:{projectKey}" + operationId: ByProjectKeyCartDiscountsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CartDiscountUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CartDiscount' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "cart-discounts" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_cart_discounts:{projectKey}" + operationId: ByProjectKeyCartDiscountsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CartDiscount' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/carts: + description: |- + A shopping cart holds product variants and can be ordered. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "carts" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyCartsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CartPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "carts" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyCartsPost + description: |- + Creating a cart can fail with an InvalidOperation if the referenced shipping method in the + CartDraft has a predicate which does not match the cart. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CartDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/carts/customer-id={customerId}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: customerId + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "carts" + - "customer-id=customerId" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyCartsCustomerIdByCustomerIdGet + description: |- + Retrieves the active cart of the customer that has been modified most recently. + It does not consider carts with CartOrigin Merchant. If no active cart exists, a 404 Not Found error is returned. + + The cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date, + send an Update request with the Recalculate update action instead. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/carts/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "carts" + - "key=key" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyCartsKeyByKeyGet + description: |- + The cart may not contain up-to-date prices, discounts etc. + If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "carts" + - "key=key" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyCartsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CartUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "carts" + - "key=key" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyCartsKeyByKeyDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/carts/replicate: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "carts" + - "replicate" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyCartsReplicatePost + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReplicaCartDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/carts/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "carts" + - "ID" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyCartsByIDGet + description: |- + The cart may not contain up-to-date prices, discounts etc. + If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "carts" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyCartsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CartUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "carts" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyCartsByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/categories: + description: |- + Categories are used to organize products in a hierarchical structure. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "categories" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_categories:{projectKey}" + operationId: ByProjectKeyCategoriesGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CategoryPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "categories" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "view_categories:{projectKey}" + operationId: ByProjectKeyCategoriesPost + description: |- + Creating a category produces the CategoryCreated message. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CategoryDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/categories/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "categories" + - "key=key" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_categories:{projectKey}" + operationId: ByProjectKeyCategoriesKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "categories" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "manage_categories:{projectKey}" + operationId: ByProjectKeyCategoriesKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CategoryUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "categories" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "manage_categories:{projectKey}" + operationId: ByProjectKeyCategoriesKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/categories/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "categories" + - "ID" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_categories:{projectKey}" + operationId: ByProjectKeyCategoriesByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "categories" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "manage_categories:{projectKey}" + operationId: ByProjectKeyCategoriesByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CategoryUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "categories" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "manage_categories:{projectKey}" + operationId: ByProjectKeyCategoriesByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Category' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/channels: + description: |- + Channels represent a source or destination of different entities. They can be used to model warehouses or stores. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "channels" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyChannelsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "channels" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyChannelsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/channels/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "channels" + - "ID" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyChannelsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "channels" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyChannelsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ChannelUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "channels" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyChannelsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Channel' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/custom-objects: + description: |- + Store custom JSON values. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "custom-objects" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_orders:{projectKey}" + - "view_customers:{projectKey}" + operationId: ByProjectKeyCustomObjectsGet + description: |- + The query endpoint allows to retrieve custom objects in a specific container or all custom objects. + For performance reasons, it is highly advisable to query only for custom objects in a container by using + the container field in the where predicate. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomObjectPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "custom-objects" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "manage_orders:{projectKey}" + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomObjectsPost + description: |- + Creates a new custom object or updates an existing custom object. + If an object with the given container/key exists, + the object will be replaced with the new value and the version is incremented. + If the request contains a version and an object with the given container/key exists then the version + must match the version of the existing object. Concurrent updates for the same custom object still can result + in a Conflict (409) even if the version is not provided. + Fields with null values will not be saved. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomObjectDraft' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomObject' + + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomObject' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/custom-objects/{container}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: container + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "custom-objects" + - "container" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_orders:{projectKey}" + - "view_customers:{projectKey}" + operationId: ByProjectKeyCustomObjectsByContainerGet + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomObjectPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/custom-objects/{container}/{key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: container + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "custom-objects" + - "container" + - "key" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_orders:{projectKey}" + - "view_customers:{projectKey}" + operationId: ByProjectKeyCustomObjectsByContainerByKeyGet + description: |- + Get CustomObject by container and key + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomObject' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "custom-objects" + - "container" + - "key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "manage_orders:{projectKey}" + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomObjectsByContainerByKeyDelete + description: |- + Delete CustomObject by container and key + parameters: + - name: version + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomObject' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customer-groups: + description: |- + customer-groups are used to evaluate products and channels. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "customer-groups" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customer_groups:{projectKey}" + operationId: ByProjectKeyCustomerGroupsGet + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerGroupPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "customer-groups" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customer_groups:{projectKey}" + operationId: ByProjectKeyCustomerGroupsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerGroupDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerGroup' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customer-groups/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "customer-groups" + - "key=key" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customer_groups:{projectKey}" + operationId: ByProjectKeyCustomerGroupsKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerGroup' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "customer-groups" + - "key=key" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customer_groups:{projectKey}" + operationId: ByProjectKeyCustomerGroupsKeyByKeyPost + description: |- + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerGroupUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerGroup' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "customer-groups" + - "key=key" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customer_groups:{projectKey}" + operationId: ByProjectKeyCustomerGroupsKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerGroup' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customer-groups/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "customer-groups" + - "ID" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customer_groups:{projectKey}" + operationId: ByProjectKeyCustomerGroupsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerGroup' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "customer-groups" + - "ID" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customer_groups:{projectKey}" + operationId: ByProjectKeyCustomerGroupsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerGroupUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerGroup' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "customer-groups" + - "ID" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customer_groups:{projectKey}" + operationId: ByProjectKeyCustomerGroupsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerGroup' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customers: + description: |- + A customer is a person purchasing products. customers, Orders, Comments and Reviews can be associated to a customer. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "customers" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + operationId: ByProjectKeyCustomersGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "customers" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomersPost + description: |- + Creates a customer. If an anonymous cart is passed in, + then the cart is assigned to the created customer and the version number of the Cart will increase. + If the ID of an anonymous session is given, all carts and orders will be assigned to the created customer. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerSignInResult' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customers/email-token: + description: |- + To verify a customer's email, an email token can be created. This should be embedded in a link and sent to the + customer via email. When the customer clicks on the link, the "verify customer's email" endpoint should be called, + which sets customer's isVerifiedEmail field to true. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "customers" + - "email-token" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomersEmailTokenPost + description: |- + Create a Token for verifying the Customer's Email + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerCreateEmailToken' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerToken' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customers/email-token={emailToken}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: emailToken + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "customers" + - "email-token=emailToken" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + operationId: ByProjectKeyCustomersEmailTokenByEmailTokenGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customers/email/confirm: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "customers" + - "email" + - "confirm" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomersEmailConfirmPost + description: |- + Verifies customer's email using a token. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerEmailVerify' + + responses: + 200: + description: |- + The email was verified. + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customers/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "customers" + - "key=key" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + operationId: ByProjectKeyCustomersKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "customers" + - "key=key" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomersKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "customers" + - "key=key" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomersKeyByKeyDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customers/password: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "customers" + - "password" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomersPasswordPost + description: |- + Change a customers password + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerChangePassword' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customers/password-token: + description: |- + The following workflow can be used to reset the customer's password: + + * Create a password reset token and send it embedded in a link to the customer. + * When the customer clicks on the link, the customer is retrieved with the token. + * The customer enters a new password and the "reset customer's password" endpoint is called. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "customers" + - "password-token" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomersPasswordTokenPost + description: |- + The token value is used to reset the password of the customer with the given email. The token is + valid only for 10 minutes. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerCreatePasswordResetToken' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerToken' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customers/password-token={passwordToken}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: passwordToken + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "customers" + - "password-token=passwordToken" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + operationId: ByProjectKeyCustomersPasswordTokenByPasswordTokenGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customers/password/reset: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "customers" + - "password" + - "reset" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomersPasswordResetPost + description: |- + Set a new password using a token. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerResetPassword' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/customers/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "customers" + - "ID" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + operationId: ByProjectKeyCustomersByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "customers" + - "ID" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomersByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "customers" + - "ID" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + operationId: ByProjectKeyCustomersByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/discount-codes: + description: |- + Discount codes can be added to a discount-code to enable certain discount-code discounts. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "discount-codes" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyDiscountCodesGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/DiscountCodePagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "discount-codes" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyDiscountCodesPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DiscountCodeDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/DiscountCode' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/discount-codes/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "discount-codes" + - "ID" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyDiscountCodesByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/DiscountCode' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "discount-codes" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyDiscountCodesByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DiscountCodeUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/DiscountCode' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "discount-codes" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyDiscountCodesByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/DiscountCode' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/extensions: + description: |- + Extend the behavior of an API with your business logic + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "extensions" + security: + - oauth_2_0: + - "manage_extensions:{projectKey}" + operationId: ByProjectKeyExtensionsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "extensions" + security: + - oauth_2_0: + - "manage_extensions:{projectKey}" + operationId: ByProjectKeyExtensionsPost + description: |- + Currently, a maximum of 25 extensions can be created per project. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/extensions/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "extensions" + - "key=key" + security: + - oauth_2_0: + - "manage_extensions:{projectKey}" + operationId: ByProjectKeyExtensionsKeyByKeyGet + description: |- + Retrieves the representation of an extension by its key. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "extensions" + - "key=key" + security: + - oauth_2_0: + - "manage_extensions:{projectKey}" + operationId: ByProjectKeyExtensionsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "extensions" + - "key=key" + security: + - oauth_2_0: + - "manage_extensions:{projectKey}" + operationId: ByProjectKeyExtensionsKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/extensions/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "extensions" + - "ID" + security: + - oauth_2_0: + - "manage_extensions:{projectKey}" + operationId: ByProjectKeyExtensionsByIDGet + description: |- + Retrieves the representation of an extension by its id. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "extensions" + - "ID" + security: + - oauth_2_0: + - "manage_extensions:{projectKey}" + operationId: ByProjectKeyExtensionsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "extensions" + - "ID" + security: + - oauth_2_0: + - "manage_extensions:{projectKey}" + operationId: ByProjectKeyExtensionsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + +# /{projectKey}/graphql: +# description: |- +# The commercetools™ platform provides a GraphQL API +# parameters: +# - name: projectKey +# in: path +# required: true +# schema: +# type: string +# post: +# tags: +# - "projectKey" +# - "graphql" +# security: +# - oauth_2_0: +# - "view_products:{projectKey}" +# operationId: ByProjectKeyGraphqlPost +# description: |- +# Execute a GraphQL query +# requestBody: +# content: +# application/graphql: +# schema: +# $ref: '#/components/schemas/GraphQLRequest' + +# responses: +# 200: +# description: |- +# 200 +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/GraphQLResponse' + +# 400: +# description: |- +# ## Bad Request + +# A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. +# Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or +# a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned +# in the response before re-sending the request. + +# The following general error codes can appear in responses with the HTTP status code `400`: + +# * `InvalidInput` +# Invalid input has been sent to the service. +# The client application should validate the input according to the constraints described in the error message +# before sending the request. + +# * `InvalidOperation` +# The resource(s) involved in the request are not in a valid state for the operation. The client application +# should validate the constraints described in the error message before sending the request. + +# * `InvalidField` +# A field has an invalid value. +# Extra fields: +# * `field` - String +# The name of the field. +# * `invalidValue` - * +# The invalid value. +# * `allowedValues` - Array of * - Optional +# A fixed set of allowed values for the field, if any. + +# * `RequiredField` +# A required field is missing a value. +# Extra fields: +# * `field` - String +# The name of the field. + +# * `DuplicateField` +# A value for a field conflicts with an existing duplicate value. +# Extra fields: +# * `field` - String +# The name of the field. +# * `duplicateValue` - * +# The offending duplicate value. +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/ErrorResponse' + +# 401: +# description: |- +# ## Unauthorized + +# A 401 indicates that the request is not properly authenticated. +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/ErrorResponse' + +# 403: +# description: |- +# ## Forbidden + +# A 403 indicates that the authenticated client is not allowed to perform the request. +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/ErrorResponse' + +# 404: +# description: |- +# ## Not Found + +# A 404 indicates that the addressed resource was not found / does not exist. + +# The following general error codes can appear in responses with the HTTP status code `404`: + +# * `ResourceNotFound` +# The resource addressed by the request URL does not exist. +# content: {} +# 500: +# description: |- +# ## Internal Server Error + +# A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent +# requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs +# to be reported and resolved. + +# The following general error codes can appear in responses with the HTTP status code `500`: + +# * `General` +# A server-side problem occurred that is not further specified. +# These errors [should be reported](http://support.commercetools.com/). +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/ErrorResponse' + +# 502: +# description: |- +# A 502 indicates that a request failed due to a server-side problem caused by platform scaling. +# The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/ErrorResponse' + +# 503: +# description: |- +# ## Service Unavailable + +# The following general error codes can appear in responses with the HTTP status code `503`: + +# * `OverCapacity` +# The service is having trouble handling the load. The client application should retry the request with +# exponential backoff up to a point where further delay is unacceptable. + +# * `PendingOperation` +# A previous conflicting operation is still pending and needs to finish before the request can succeed. +# The client application should retry the request with exponential backoff up to a point where further delay +# is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). +# content: +# application/json: +# schema: +# $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/carts: + description: |- + A shopping cart holds product variants and can be ordered. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "carts" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsGet + description: |- + Queries carts in a specific Store. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CartPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "carts" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsPost + description: |- + Creates a cart in the store specified by {storeKey}. + When using this endpoint the cart's store field is always set to the store specified in the path parameter. + Creating a cart can fail with an InvalidOperation if the referenced shipping method + in the CartDraft has a predicate which does not match the cart. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CartDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/carts/customer-id={customerId}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: customerId + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "carts" + - "customer-id=customerId" + security: + - oauth_2_0: + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdGet + description: |- + Retrieves the active cart of the customer that has been modified most recently in a specific Store. + + If the cart exists in the commercetools project but does not have the store field, or the store field + references a different store, this method returns a ResourceNotFound error. + + The cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date, + send an Update request with the Recalculate update action instead. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/carts/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "carts" + - "key=key" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyGet + description: |- + Returns a cart by its key from a specific Store. + If the cart exists in the commercetools project but does not have the store field, + or the store field references a different store, this method returns a ResourceNotFound error. + The cart may not contain up-to-date prices, discounts etc. + If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "carts" + - "key=key" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyPost + description: |- + Updates a cart in the store specified by {storeKey}. + If the cart exists in the commercetools project but does not have the store field, + or the store field references a different store, this method returns a ResourceNotFound error. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CartUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "carts" + - "key=key" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/carts/replicate: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "carts" + - "replicate" + security: + - oauth_2_0: + - "manage_orders:{projectKey}:{storeKey}" + - "manage_orders:{projectKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsReplicatePost + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReplicaCartDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/carts/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "carts" + - "ID" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsByIDGet + description: |- + Returns a cart by its ID from a specific Store. + If the cart exists in the commercetools project but does not have the store field, + or the store field references a different store, this method returns a ResourceNotFound error. + The cart may not contain up-to-date prices, discounts etc. + If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "carts" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsByIDPost + description: |- + Updates a cart in the store specified by {storeKey}. + If the cart exists in the commercetools project but does not have the store field, + or the store field references a different store, this method returns a ResourceNotFound error. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CartUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "carts" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/customers: + description: |- + A customer is a person purchasing products. customers, Orders, + Comments and Reviews can be associated to a customer. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersPost + description: |- + Creates a customer in a specific Store. + When using this endpoint, if omitted, + the customer's stores field is set to the store specified in the path parameter. + If an anonymous cart is passed in as when using this method, + then the cart is assigned to the created customer and the version number of the Cart increases. + If the ID of an anonymous session is given, all carts and orders will be assigned to the created customer and + the store specified. If you pass in a cart with a store field specified, + the store field must reference the same store specified in the {storeKey} path parameter. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerSignInResult' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/customers/email-token: + description: |- + To verify a customer's email, an email token can be created. This should be embedded in a link and sent to the + customer via email. When the customer clicks on the link, + the "verify customer's email" endpoint should be called, + which sets customer's isVerifiedEmail field to true. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "email-token" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenPost + description: |- + Create a Token for verifying the Customer's Email in store + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerCreateEmailToken' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerToken' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/customers/email-token={emailToken}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: emailToken + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "email-token=emailToken" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersEmailTokenByEmailTokenGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/customers/email/confirm: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "email" + - "confirm" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersEmailConfirmPost + description: |- + Verifies customer's email using a token. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerEmailVerify' + + responses: + 200: + description: |- + The email was verified. + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/customers/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "key=key" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyGet + description: |- + Returns a customer by its Key from a specific Store. + It also considers customers that do not have the stores field. + If the customer exists in the commercetools project but the stores field references different stores, + this method returns a ResourceNotFound error. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "key=key" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyPost + description: |- + If the customer exists in the commercetools project but the stores field references a different store, + this method returns a ResourceNotFound error. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "key=key" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/customers/password: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "password" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordPost + description: |- + Change a customers password + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerChangePassword' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/customers/password-token: + description: |- + The following workflow can be used to reset the customer's password: + + * Create a password reset token and send it embedded in a link to the customer. + * When the customer clicks on the link, the customer is retrieved with the token. + * The customer enters a new password and the "reset customer's password" endpoint is called. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "password-token" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenPost + description: |- + The token value is used to reset the password of the customer with the given email. The token is + valid only for 10 minutes. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerCreatePasswordResetToken' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerToken' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/customers/password-token={passwordToken}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: passwordToken + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "password-token=passwordToken" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordTokenByPasswordTokenGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/customers/password/reset: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "password" + - "reset" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersPasswordResetPost + description: |- + Set a new password using a token. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerResetPassword' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/customers/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "ID" + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersByIDGet + description: |- + Returns a customer by its ID from a specific Store. + It also considers customers that do not have the stores field. + If the customer exists in the commercetools project but the stores field references different stores, + this method returns a ResourceNotFound error. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "ID" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersByIDPost + description: |- + Updates a customer in the store specified by {storeKey}. + If the customer exists in the commercetools project but the stores field references a different store, + this method returns a ResourceNotFound error. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "customers" + - "ID" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/login: + description: |- + Retrieves the authenticated customer. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "login" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyLoginPost + description: |- + Authenticate Customer (Sign In) in store + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerSignin' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerSignInResult' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/me/active-cart: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "active-cart" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeActiveCartGet + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/me/carts: + description: |- + A shopping cart holds product variants and can be ordered. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "carts" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeCartsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CartPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "carts" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeCartsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyCartDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/me/carts/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "carts" + - "ID" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "carts" + - "ID" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyCartUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "carts" + - "ID" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/me/orders: + description: |- + An order can be created from a order, usually after a checkout process has been completed. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "orders" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeOrdersGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "orders" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeOrdersPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyOrderFromCartDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/me/orders/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "orders" + - "ID" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/me/shopping-lists: + description: |- + shopping-lists e.g. for wishlist support + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "shopping-lists" + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + - "view_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingListPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "shopping-lists" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + - "manage_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyShoppingListDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/me/shopping-lists/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + - "view_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyGet + description: |- + Gets a shopping list by Key. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + - "manage_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyPost + description: |- + Update a shopping list found by its Key. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyShoppingListUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + - "manage_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/me/shopping-lists/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + - "view_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDGet + description: |- + Gets a shopping list by ID. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + - "manage_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyShoppingListUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "me" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + - "manage_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/orders: + description: |- + An order can be created from a cart, usually after a checkout process has been completed. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "orders" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyOrdersGet + description: |- + Queries orders in a specific Store. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "orders" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyOrdersPost + description: |- + Creates an order from a Cart from a specific Store. + When using this endpoint the orders's store field is always set to the store specified in the path parameter. + The cart must have a shipping address set before creating an order. When using the Platform TaxMode, + the shipping address is used for tax calculation. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderFromCartDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/orders/order-number={orderNumber}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: orderNumber + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "orders" + - "order-number=orderNumber" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberGet + description: |- + Returns an order by its order number from a specific Store. + + If the order exists in the commercetools project but does not have the store field, + or the store field references a different store, this method returns a ResourceNotFound error. + In case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+, + it should be provided in URL-encoded format. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "orders" + - "order-number=orderNumber" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberPost + description: |- + Updates an order in the store specified by {storeKey}. + If the order exists in the commercetools project but does not have the store field, + or the store field references a different store, this method returns a ResourceNotFound error. + In case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+, + it should be provided in URL-encoded format. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "orders" + - "order-number=orderNumber" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/orders/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "orders" + - "ID" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyOrdersByIDGet + description: |- + Returns an order by its ID from a specific Store. + If the order exists in the commercetools project but does not have the store field, + or the store field references a different store, this method returns a ResourceNotFound error. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "orders" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyOrdersByIDPost + description: |- + Updates an order in the store specified by {storeKey}. + If the order exists in the commercetools project but does not have the store field, + or the store field references a different store, this method returns a ResourceNotFound error. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "orders" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyOrdersByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/product-projections: + description: |- + A projected representation of a product shows the product with its current or staged data. The current or staged + representation of a product in a catalog is called a product projection. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "product-projections" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyProductProjectionsGet + description: |- + You can use the product projections query endpoint to get the current or staged representations of Products. + When used with an API client that has the view_published_products:{projectKey} scope, + this endpoint only returns published (current) product projections. + parameters: + - name: staged + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductProjectionPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/product-projections/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "product-projections" + - "key=key" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyGet + description: |- + Gets the current or staged representation of a product by its ID from a specific Store. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductProjection' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/product-projections/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "product-projections" + - "ID" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDGet + description: |- + Gets the current or staged representation of a product by its ID from a specific Store. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductProjection' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/product-selection-assignments: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "product-selection-assignments" + security: + - oauth_2_0: + - "view_product_selections:{projectKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyProductSelectionAssignmentsGet + description: |- + Queries Product Selection assignments in a specific Store. + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductsInStorePagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/shipping-methods/matching-cart: + description: |- + Get ShippingMethods for a cart in a store + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "shipping-methods" + - "matching-cart" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + - "view_shipping_methods:{projectKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartGet + parameters: + - name: cartId + in: query + required: true + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethodPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/shopping-lists: + description: |- + shopping-lists e.g. for wishlist support + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "shopping-lists" + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + - "view_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingListPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "shopping-lists" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + - "manage_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingListDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/shopping-lists/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + - "view_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyGet + description: |- + Gets a shopping list by Key. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + - "manage_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyPost + description: |- + Update a shopping list found by its Key. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingListUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + - "manage_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/in-store/key={storeKey}/shopping-lists/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: storeKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + - "view_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDGet + description: |- + Gets a shopping list by ID. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + - "manage_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingListUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "in-store" + - "key=storeKey" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + - "manage_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/inventory: + description: |- + Inventory allows you to track stock quantities. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "inventory" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyInventoryGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "inventory" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyInventoryPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryEntryDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryEntry' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/inventory/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "inventory" + - "ID" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyInventoryByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryEntry' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "inventory" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyInventoryByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryEntryUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryEntry' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "inventory" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyInventoryByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/InventoryEntry' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/login: + description: |- + Retrieves the authenticated customer. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "login" + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + operationId: ByProjectKeyLoginPost + description: |- + Authenticate Customer (Sign In). Retrieves the authenticated + customer (a customer that matches the given email/password pair). + If used with an access token for Anonymous Sessions, + all orders and carts belonging to the anonymousId will be assigned to the newly created customer. + If a cart is is returned as part of the CustomerSignInResult, + it has been recalculated (It will have up-to-date prices, taxes and discounts, + and invalid line items have been removed.). + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerSignin' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerSignInResult' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + security: + - oauth_2_0: + - "manage_my_profile:{projectKey}" + operationId: ByProjectKeyMeGet + parameters: + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "me" + security: + - oauth_2_0: + - "manage_my_profile:{projectKey}" + operationId: ByProjectKeyMePost + description: |- + Update my customer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyCustomerUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "me" + security: + - oauth_2_0: + - "manage_my_profile:{projectKey}" + operationId: ByProjectKeyMeDelete + description: |- + Delete my Customer + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/active-cart: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "active-cart" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeActiveCartGet + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/carts: + description: |- + A shopping cart holds product variants and can be ordered. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "carts" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeCartsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CartPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "me" + - "carts" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeCartsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyCartDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/carts/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "carts" + - "key=key" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeCartsKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "me" + - "carts" + - "key=key" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeCartsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyCartUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "me" + - "carts" + - "key=key" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeCartsKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/carts/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "carts" + - "ID" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeCartsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "me" + - "carts" + - "ID" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeCartsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyCartUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "me" + - "carts" + - "ID" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeCartsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Cart' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/email/confirm: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "me" + - "email" + - "confirm" + security: + - oauth_2_0: + - "manage_my_profile:{projectKey}" + operationId: ByProjectKeyMeEmailConfirmPost + responses: + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/login: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "me" + - "login" + security: + - oauth_2_0: + - "manage_my_profile:{projectKey}" + operationId: ByProjectKeyMeLoginPost + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerSignin' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerSignInResult' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/orders: + description: |- + An order can be created from a cart, usually after a checkout process has been completed. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "orders" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeOrdersGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "me" + - "orders" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeOrdersPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyOrderFromCartDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/orders/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "orders" + - "ID" + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeOrdersByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/password: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "me" + - "password" + security: + - oauth_2_0: + - "manage_my_profile:{projectKey}" + operationId: ByProjectKeyMePasswordPost + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyCustomerChangePassword' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/password/reset: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "me" + - "password" + - "reset" + security: + - oauth_2_0: + - "manage_my_profile:{projectKey}" + operationId: ByProjectKeyMePasswordResetPost + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Customer' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/payments: + description: |- + The My Payments endpoint creates and provides access to payments scoped to a specific user. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "payments" + security: + - oauth_2_0: + - "manage_my_payments:{projectKey}" + operationId: ByProjectKeyMePaymentsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/MyPaymentPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "me" + - "payments" + security: + - oauth_2_0: + - "manage_my_payments:{projectKey}" + operationId: ByProjectKeyMePaymentsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyPaymentDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/MyPayment' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/payments/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "payments" + - "key=key" + security: + - oauth_2_0: + - "manage_my_payments:{projectKey}" + operationId: ByProjectKeyMePaymentsKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/MyPayment' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "me" + - "payments" + - "key=key" + security: + - oauth_2_0: + - "manage_my_payments:{projectKey}" + operationId: ByProjectKeyMePaymentsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyPaymentUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/MyPayment' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "me" + - "payments" + - "key=key" + security: + - oauth_2_0: + - "manage_my_payments:{projectKey}" + operationId: ByProjectKeyMePaymentsKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/MyPayment' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/payments/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "payments" + - "ID" + security: + - oauth_2_0: + - "manage_my_payments:{projectKey}" + operationId: ByProjectKeyMePaymentsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/MyPayment' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "me" + - "payments" + - "ID" + security: + - oauth_2_0: + - "manage_my_payments:{projectKey}" + operationId: ByProjectKeyMePaymentsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyPaymentUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/MyPayment' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "me" + - "payments" + - "ID" + security: + - oauth_2_0: + - "manage_my_payments:{projectKey}" + operationId: ByProjectKeyMePaymentsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/MyPayment' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/shopping-lists: + description: |- + The My Shopping Lists endpoint creates and provides access to shopping lists scoped to a specific user. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "shopping-lists" + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + operationId: ByProjectKeyMeShoppingListsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingListPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "me" + - "shopping-lists" + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + operationId: ByProjectKeyMeShoppingListsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyShoppingListDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/shopping-lists/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + operationId: ByProjectKeyMeShoppingListsKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "me" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + operationId: ByProjectKeyMeShoppingListsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyShoppingListUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "me" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + operationId: ByProjectKeyMeShoppingListsKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/shopping-lists/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "me" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + operationId: ByProjectKeyMeShoppingListsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "me" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + operationId: ByProjectKeyMeShoppingListsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyShoppingListUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "me" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + operationId: ByProjectKeyMeShoppingListsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/me/signup: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "me" + - "signup" + security: + - oauth_2_0: + - "manage_my_profile:{projectKey}" + operationId: ByProjectKeyMeSignupPost + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MyCustomerDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerSignInResult' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/messages: + description: |- + A message represents a change or an action performed on a resource (like an Order or a Product). + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "messages" + security: + - oauth_2_0: + - "view_messages:{projectKey}" + operationId: ByProjectKeyMessagesGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/MessagePagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/messages/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "messages" + - "ID" + security: + - oauth_2_0: + - "view_messages:{projectKey}" + operationId: ByProjectKeyMessagesByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Message' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/orders: + description: |- + An order can be created from a order, usually after a checkout process has been completed. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "orders" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyOrdersGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "orders" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyOrdersPost + description: |- + Creates an order from a Cart. + The cart must have a shipping address set before creating an order. + When using the Platform TaxMode, the shipping address is used for tax calculation. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderFromCartDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/orders/edits: + description: |- + OrderEdit are containers for financial changes after an Order has been placed. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "orders" + - "edits" + security: + - oauth_2_0: + - "view_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEditPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "orders" + - "edits" + security: + - oauth_2_0: + - "manage_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEditDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEdit' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/orders/edits/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "orders" + - "edits" + - "key=key" + security: + - oauth_2_0: + - "view_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEdit' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "orders" + - "edits" + - "key=key" + security: + - oauth_2_0: + - "manage_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEditUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEdit' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "orders" + - "edits" + - "key=key" + security: + - oauth_2_0: + - "manage_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEdit' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/orders/edits/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "orders" + - "edits" + - "ID" + security: + - oauth_2_0: + - "view_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEdit' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "orders" + - "edits" + - "ID" + security: + - oauth_2_0: + - "manage_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEditUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEdit' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "orders" + - "edits" + - "ID" + security: + - oauth_2_0: + - "manage_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEdit' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/orders/edits/{ID}/apply: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "orders" + - "edits" + - "ID" + - "apply" + security: + - oauth_2_0: + - "manage_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsByIDApplyPost + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderEditApply' + + responses: + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/orders/import: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "orders" + - "import" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyOrdersImportPost + description: |- + Create an Order by Import + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderImportDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/orders/order-number={orderNumber}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: orderNumber + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "orders" + - "order-number=orderNumber" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyOrdersOrderNumberByOrderNumberGet + description: |- + In case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+, + it should be provided in URL-encoded format. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "orders" + - "order-number=orderNumber" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyOrdersOrderNumberByOrderNumberPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "orders" + - "order-number=orderNumber" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyOrdersOrderNumberByOrderNumberDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/orders/search: + description: |- + This endpoint provides high performance search queries over Orders. The order search allows searching through all orders (currently supporting a limit of the 10.000.000 newest orders) in your project. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "orders" + - "search" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyOrdersSearchPost + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderSearchRequest' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/OrderPagedSearchResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + head: + tags: + - "projectKey" + - "orders" + - "search" + security: + - oauth_2_0: + - "project_settings:{projectKey}" + operationId: ByProjectKeyOrdersSearchHead + description: |- + Checks whether a search index for the Project's Orders exists. + responses: + 200: + description: |- + The index exists and the Search Orders endpoint can be used. + content: {} + 404: + description: |- + The index does not exist and the Search Orders endpoint returns Error 404 only. + content: {} + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/orders/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "orders" + - "ID" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyOrdersByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "orders" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyOrdersByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OrderUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "orders" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyOrdersByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/payments: + description: |- + Payments hold information about the current state of receiving and/or refunding money + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "payments" + security: + - oauth_2_0: + - "view_payments:{projectKey}" + operationId: ByProjectKeyPaymentsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "payments" + security: + - oauth_2_0: + - "manage_payments:{projectKey}" + operationId: ByProjectKeyPaymentsPost + description: |- + To create a payment object a payment draft object has to be given with the request. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Payment' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/payments/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "payments" + - "key=key" + security: + - oauth_2_0: + - "view_payments:{projectKey}" + operationId: ByProjectKeyPaymentsKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Payment' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "payments" + - "key=key" + security: + - oauth_2_0: + - "manage_payments:{projectKey}" + operationId: ByProjectKeyPaymentsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Payment' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "payments" + - "key=key" + security: + - oauth_2_0: + - "manage_payments:{projectKey}" + operationId: ByProjectKeyPaymentsKeyByKeyDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Payment' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/payments/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "payments" + - "ID" + security: + - oauth_2_0: + - "view_payments:{projectKey}" + operationId: ByProjectKeyPaymentsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Payment' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "payments" + - "ID" + security: + - oauth_2_0: + - "manage_payments:{projectKey}" + operationId: ByProjectKeyPaymentsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PaymentUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Payment' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "payments" + - "ID" + security: + - oauth_2_0: + - "manage_payments:{projectKey}" + operationId: ByProjectKeyPaymentsByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Payment' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-discounts: + description: |- + Product discounts are used to change certain product prices. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-discounts" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscountPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "product-discounts" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscountDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscount' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-discounts/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-discounts" + - "key=key" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscount' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "product-discounts" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscountUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscount' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "product-discounts" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscount' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-discounts/matching: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "product-discounts" + - "matching" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsMatchingPost + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscountMatchQuery' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscount' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-discounts/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-discounts" + - "ID" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscount' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "product-discounts" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscountUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscount' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "product-discounts" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDiscount' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-projections: + description: |- + A projected representation of a product shows the product with its current or staged data. The current or staged + representation of a product in a catalog is called a product projection. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-projections" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyProductProjectionsGet + description: |- + You can use the product projections query endpoint to get the current or staged representations of Products. + When used with an API client that has the view_published_products:{projectKey} scope, + this endpoint only returns published (current) product projections. + parameters: + - name: staged + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductProjectionPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-projections/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-projections" + - "key=key" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyProductProjectionsKeyByKeyGet + description: |- + Gets the current or staged representation of a product found by Key. + When used with an API client that has the view_published_products:{projectKey} scope, + this endpoint only returns published (current) product projections. + parameters: + - name: staged + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductProjection' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-projections/search: + description: |- + This endpoint provides high performance search queries over ProductProjections. The query result contains the + ProductProjections for which at least one ProductVariant matches the search query. This means that variants can + be included in the result also for which the search query does not match. To determine which ProductVariants match + the search query, the returned ProductProjections include the additional field isMatchingVariant. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "product-projections" + - "search" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyProductProjectionsSearchPost + description: |- + Search Product Projection + requestBody: + content: + application/x-www-form-urlencoded: + schema: + $ref: "#/components/schemas/URLEncodedPayload" + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductProjectionPagedSearchResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + get: + tags: + - "projectKey" + - "product-projections" + - "search" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyProductProjectionsSearchGet + description: |- + Search Product Projection + parameters: + - name: fuzzy + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: fuzzyLevel + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: markMatchingVariants + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: staged + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: filter + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + - name: filter.facets + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + - name: filter.query + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + - name: facet + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + - name: /text.[a-z]{2}(-[A-Z]{2})?/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductProjectionPagedSearchResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-projections/suggest: + description: |- + The source of data for suggestions is the searchKeyword field in a product + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-projections" + - "suggest" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyProductProjectionsSuggestGet + parameters: + - name: fuzzy + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: staged + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: /searchKeywords.[a-z]{2}(-[A-Z]{2})?/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + type: object + additionalProperties: true + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-projections/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-projections" + - "ID" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyProductProjectionsByIDGet + description: |- + Gets the current or staged representation of a product in a catalog by ID. + When used with an API client that has the view_published_products:{projectKey} scope, + this endpoint only returns published (current) product projections. + parameters: + - name: staged + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductProjection' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-selections: + description: |- + Manage individual Store assortments through Product Selections. + + After you have created Product Selections and populated them by Products, + you can manage Store assortments by assigning Product Selections to Stores. + Product Selections may be used by a single Store or shared across several Stores. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-selections" + security: + - oauth_2_0: + - "view_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelectionPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "product-selections" + security: + - oauth_2_0: + - "manage_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelectionDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelection' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-selections/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-selections" + - "key=key" + security: + - oauth_2_0: + - "view_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelection' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "product-selections" + - "key=key" + security: + - oauth_2_0: + - "manage_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelectionUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelection' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "product-selections" + - "key=key" + security: + - oauth_2_0: + - "manage_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsKeyByKeyDelete + description: |- + Deletion will only succeed if the Product Selection is not assigned to any [Store](/../api/projects/stores#store). + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelection' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-selections/key={key}/products: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-selections" + - "key=key" + - "products" + security: + - oauth_2_0: + - "view_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsKeyByKeyProductsGet + description: |- + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelectionProductPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-selections/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-selections" + - "ID" + security: + - oauth_2_0: + - "view_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelection' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "product-selections" + - "ID" + security: + - oauth_2_0: + - "manage_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelectionUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelection' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "product-selections" + - "ID" + security: + - oauth_2_0: + - "manage_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsByIDDelete + description: |- + Deletion will only succeed if the Product Selection is not assigned to any [Store](/../api/projects/stores#store). + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelection' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-selections/{ID}/products: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-selections" + - "ID" + - "products" + security: + - oauth_2_0: + - "view_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsByIDProductsGet + description: |- + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelectionProductPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-types: + description: |- + Product Types are used to describe common characteristics, most importantly common custom attributes, + of many concrete products. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-types" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductTypesGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductTypePagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "product-types" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductTypesPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductTypeDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductType' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-types/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-types" + - "key=key" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductTypesKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductType' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "product-types" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductTypesKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductTypeUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductType' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "product-types" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductTypesKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductType' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/product-types/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "product-types" + - "ID" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductTypesByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductType' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "product-types" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductTypesByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductTypeUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductType' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "product-types" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductTypesByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductType' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/products: + description: |- + Products are the sellable goods in an e-commerce project on CTP. This document explains some design concepts + of products on CTP and describes the available HTTP APIs for working with them. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "products" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductsGet + description: |- + You can use the query endpoint to get the full representations of products. + REMARK: We suggest to use the performance optimized search endpoint which has a bunch functionalities, + the query API lacks like sorting on custom attributes, etc. + parameters: + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + head: + tags: + - "projectKey" + - "products" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductsHead + description: |- + Checks if products exist. + responses: + 200: + description: |- + At least one Product matching the query exists + content: {} + 404: + description: |- + ## Not Found + + A 404 in case no Product could be found that is matching the query condition. + content: {} + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "products" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductsPost + description: |- + To create a new product, send a representation that is going to become the initial staged representation + of the new product in the master catalog. If price selection query parameters are provided, + the selected prices will be added to the response. + parameters: + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/products/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "products" + - "key=key" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductsKeyByKeyGet + description: |- + Gets the full representation of a product by Key. + parameters: + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + head: + tags: + - "projectKey" + - "products" + - "key=key" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductsKeyByKeyHead + description: |- + Checks if product with given key exists. + responses: + 200: + description: |- + The Product exists + content: {} + 404: + description: |- + ## Not Found + + A 404 indicates that the Product was not found / does not exist. + content: {} + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "products" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductsKeyByKeyPost + parameters: + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "products" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductsKeyByKeyDelete + parameters: + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/products/key={key}/product-selections: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "products" + - "key=key" + - "product-selections" + security: + - oauth_2_0: + - "view_product_selections:{projectKey}" + operationId: ByProjectKeyProductsKeyByKeyProductSelectionsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelectionPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/products/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "products" + - "ID" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductsByIDGet + description: |- + Gets the full representation of a product by ID. + parameters: + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + head: + tags: + - "projectKey" + - "products" + - "ID" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductsByIDHead + description: |- + Checks if product with given ID exists. + responses: + 200: + description: |- + The Product exists + content: {} + 404: + description: |- + ## Not Found + + A 404 indicates that the Product was not found / does not exist. + content: {} + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "products" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductsByIDPost + parameters: + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ProductUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "products" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductsByIDDelete + parameters: + - name: priceCurrency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCountry + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceCustomerGroup + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: priceChannel + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: localeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: storeProjection + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/products/{ID}/images: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + post: + tags: + - "projectKey" + - "products" + - "ID" + - "images" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyProductsByIDImagesPost + description: |- + Uploads a binary image file to a given product variant. The supported image formats are JPEG, PNG and GIF. + parameters: + - name: filename + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: variant + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: sku + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: staged + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + requestBody: + content: + application/octet-stream: + schema: + type: string + format: binary + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + + /{projectKey}/products/{ID}/product-selections: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "products" + - "ID" + - "product-selections" + security: + - oauth_2_0: + - "view_product_selections:{projectKey}" + operationId: ByProjectKeyProductsByIDProductSelectionsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ProductSelectionPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/reviews: + description: |- + Reviews are used to evaluate products and channels. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "reviews" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyReviewsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ReviewPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "reviews" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyReviewsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReviewDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Review' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/reviews/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "reviews" + - "key=key" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyReviewsKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Review' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "reviews" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyReviewsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReviewUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Review' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "reviews" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyReviewsKeyByKeyDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Review' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/reviews/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "reviews" + - "ID" + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyReviewsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Review' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "reviews" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyReviewsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ReviewUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Review' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "reviews" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + operationId: ByProjectKeyReviewsByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Review' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/shipping-methods: + description: |- + Shipping Methods define where orders can be shipped and what the costs are. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "shipping-methods" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethodPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "shipping-methods" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethodDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethod' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/shipping-methods/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "shipping-methods" + - "key=key" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethod' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "shipping-methods" + - "key=key" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethodUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethod' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "shipping-methods" + - "key=key" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethod' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/shipping-methods/matching-cart: + description: |- + Get ShippingMethods for a cart + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "shipping-methods" + - "matching-cart" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsMatchingCartGet + parameters: + - name: cartId + in: query + required: true + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethodPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/shipping-methods/matching-location: + description: |- + Get ShippingMethods for a location + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "shipping-methods" + - "matching-location" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsMatchingLocationGet + parameters: + - name: country + in: query + required: true + style: form + schema: + type: "string" + explode: true + - name: state + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: currency + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethodPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/shipping-methods/matching-orderedit: + description: |- + Get ShippingMethods for an order edit + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "shipping-methods" + - "matching-orderedit" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsMatchingOrdereditGet + parameters: + - name: orderEditId + in: query + required: true + style: form + schema: + type: "string" + explode: true + - name: country + in: query + required: true + style: form + schema: + type: "string" + explode: true + - name: state + in: query + required: false + style: form + schema: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethodPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/shipping-methods/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "shipping-methods" + - "ID" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethod' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "shipping-methods" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethodUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethod' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "shipping-methods" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethod' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/shopping-lists: + description: |- + shopping-lists e.g. for wishlist support + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "shopping-lists" + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + operationId: ByProjectKeyShoppingListsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingListPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "shopping-lists" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + operationId: ByProjectKeyShoppingListsPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingListDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/shopping-lists/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + operationId: ByProjectKeyShoppingListsKeyByKeyGet + description: |- + Gets a shopping list by Key. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + operationId: ByProjectKeyShoppingListsKeyByKeyPost + description: |- + Update a shopping list found by its Key. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingListUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "shopping-lists" + - "key=key" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + operationId: ByProjectKeyShoppingListsKeyByKeyDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/shopping-lists/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + operationId: ByProjectKeyShoppingListsByIDGet + description: |- + Gets a shopping list by ID. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + operationId: ByProjectKeyShoppingListsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingListUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "shopping-lists" + - "ID" + security: + - oauth_2_0: + - "manage_shopping_lists:{projectKey}" + operationId: ByProjectKeyShoppingListsByIDDelete + parameters: + - name: dataErasure + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ShoppingList' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/states: + description: |- + The commercetools platform allows you to model states of certain objects, such as orders, line items, products, + reviews, and payments in order to define finite state machines reflecting the business logic you'd like to + implement. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "states" + security: + - oauth_2_0: + - "view_states:{projectKey}" + operationId: ByProjectKeyStatesGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/StatePagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "states" + security: + - oauth_2_0: + - "manage_states:{projectKey}" + operationId: ByProjectKeyStatesPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StateDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/State' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/states/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "states" + - "key=key" + security: + - oauth_2_0: + - "view_states:{projectKey}" + operationId: ByProjectKeyStatesKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/State' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "states" + - "key=key" + security: + - oauth_2_0: + - "manage_states:{projectKey}" + operationId: ByProjectKeyStatesKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StateUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/State' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "states" + - "key=key" + security: + - oauth_2_0: + - "manage_states:{projectKey}" + operationId: ByProjectKeyStatesKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/State' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/states/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "states" + - "ID" + security: + - oauth_2_0: + - "view_states:{projectKey}" + operationId: ByProjectKeyStatesByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/State' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "states" + - "ID" + security: + - oauth_2_0: + - "manage_states:{projectKey}" + operationId: ByProjectKeyStatesByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StateUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/State' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "states" + - "ID" + security: + - oauth_2_0: + - "manage_states:{projectKey}" + operationId: ByProjectKeyStatesByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/State' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/stores: + description: |- + Stores let you model the context your customers shop in. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "stores" + security: + - oauth_2_0: + - "view_stores:{projectKey}" + operationId: ByProjectKeyStoresGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/StorePagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "stores" + security: + - oauth_2_0: + - "manage_stores:{projectKey}" + operationId: ByProjectKeyStoresPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StoreDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Store' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/stores/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "stores" + - "key=key" + security: + - oauth_2_0: + - "view_stores:{projectKey}" + operationId: ByProjectKeyStoresKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Store' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "stores" + - "key=key" + security: + - oauth_2_0: + - "manage_stores:{projectKey}" + operationId: ByProjectKeyStoresKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StoreUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Store' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "stores" + - "key=key" + security: + - oauth_2_0: + - "manage_stores:{projectKey}" + operationId: ByProjectKeyStoresKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Store' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/stores/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "stores" + - "ID" + security: + - oauth_2_0: + - "view_stores:{projectKey}" + operationId: ByProjectKeyStoresByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Store' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "stores" + - "ID" + security: + - oauth_2_0: + - "manage_stores:{projectKey}" + operationId: ByProjectKeyStoresByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StoreUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Store' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "stores" + - "ID" + security: + - oauth_2_0: + - "manage_stores:{projectKey}" + operationId: ByProjectKeyStoresByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Store' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/subscriptions: + description: |- + Subscriptions allow you to be notified of new messages or changes via a Message Queue of your choice + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "subscriptions" + security: + - oauth_2_0: + - "manage_subscriptions:{projectKey}" + operationId: ByProjectKeySubscriptionsGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "subscriptions" + security: + - oauth_2_0: + - "manage_subscriptions:{projectKey}" + operationId: ByProjectKeySubscriptionsPost + description: |- + The creation of a Subscription is eventually consistent, it may take up to a minute before it becomes fully active. + In order to test that the destination is correctly configured, a test message will be put into the queue. + If the message could not be delivered, the subscription will not be created. + The payload of the test message is a notification of type ResourceCreated for the resourceTypeId subscription. + Currently, a maximum of 25 subscriptions can be created per project. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/subscriptions/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "subscriptions" + - "key=key" + security: + - oauth_2_0: + - "manage_subscriptions:{projectKey}" + operationId: ByProjectKeySubscriptionsKeyByKeyGet + description: |- + Retrieves the representation of a subscription by its key. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "subscriptions" + - "key=key" + security: + - oauth_2_0: + - "manage_subscriptions:{projectKey}" + operationId: ByProjectKeySubscriptionsKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "subscriptions" + - "key=key" + security: + - oauth_2_0: + - "manage_subscriptions:{projectKey}" + operationId: ByProjectKeySubscriptionsKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/subscriptions/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "subscriptions" + - "ID" + security: + - oauth_2_0: + - "manage_subscriptions:{projectKey}" + operationId: ByProjectKeySubscriptionsByIDGet + description: |- + Retrieves the representation of a subscription by its id. + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "subscriptions" + - "ID" + security: + - oauth_2_0: + - "manage_subscriptions:{projectKey}" + operationId: ByProjectKeySubscriptionsByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "subscriptions" + - "ID" + security: + - oauth_2_0: + - "manage_subscriptions:{projectKey}" + operationId: ByProjectKeySubscriptionsByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Subscription' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/tax-categories: + description: |- + Tax Categories define how products are to be taxed in different countries. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "tax-categories" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_tax_categories:{projectKey}" + operationId: ByProjectKeyTaxCategoriesGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/TaxCategoryPagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "tax-categories" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "manage_tax_categories:{projectKey}" + operationId: ByProjectKeyTaxCategoriesPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TaxCategoryDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/TaxCategory' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/tax-categories/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "tax-categories" + - "key=key" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_tax_categories:{projectKey}" + operationId: ByProjectKeyTaxCategoriesKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/TaxCategory' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "tax-categories" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "manage_tax_categories:{projectKey}" + operationId: ByProjectKeyTaxCategoriesKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TaxCategoryUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/TaxCategory' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "tax-categories" + - "key=key" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "manage_tax_categories:{projectKey}" + operationId: ByProjectKeyTaxCategoriesKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/TaxCategory' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/tax-categories/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "tax-categories" + - "ID" + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_tax_categories:{projectKey}" + operationId: ByProjectKeyTaxCategoriesByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/TaxCategory' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "tax-categories" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "manage_tax_categories:{projectKey}" + operationId: ByProjectKeyTaxCategoriesByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TaxCategoryUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/TaxCategory' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "tax-categories" + - "ID" + security: + - oauth_2_0: + - "manage_products:{projectKey}" + - "manage_tax_categories:{projectKey}" + operationId: ByProjectKeyTaxCategoriesByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/TaxCategory' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/types: + description: |- + Types define custom fields that are used to enhance resources as you need. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "types" + security: + - oauth_2_0: + - "view_types:{projectKey}" + operationId: ByProjectKeyTypesGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/TypePagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "types" + security: + - oauth_2_0: + - "manage_types:{projectKey}" + operationId: ByProjectKeyTypesPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TypeDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Type' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/types/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "types" + - "key=key" + security: + - oauth_2_0: + - "view_types:{projectKey}" + operationId: ByProjectKeyTypesKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Type' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "types" + - "key=key" + security: + - oauth_2_0: + - "manage_types:{projectKey}" + operationId: ByProjectKeyTypesKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TypeUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Type' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "types" + - "key=key" + security: + - oauth_2_0: + - "manage_types:{projectKey}" + operationId: ByProjectKeyTypesKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Type' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/types/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "types" + - "ID" + security: + - oauth_2_0: + - "view_types:{projectKey}" + operationId: ByProjectKeyTypesByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Type' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "types" + - "ID" + security: + - oauth_2_0: + - "manage_types:{projectKey}" + operationId: ByProjectKeyTypesByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TypeUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Type' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "types" + - "ID" + security: + - oauth_2_0: + - "manage_types:{projectKey}" + operationId: ByProjectKeyTypesByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Type' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/zones: + description: |- + Zones allow defining ShippingRates for specific Locations. + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "zones" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyZonesGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + - name: sort + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Sort' + explode: true + - name: limit + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: offset + in: query + required: false + style: form + schema: + type: "number" + format: "double" + explode: true + - name: withTotal + x-annotation-default: true + in: query + required: false + style: form + schema: + type: "boolean" + explode: true + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + - name: /^var[.][a-zA-Z0-9]+$/ + in: query + required: false + style: form + schema: + type: "array" + items: + type: "string" + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/ZonePagedQueryResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "zones" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyZonesPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneDraft' + + responses: + 201: + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/Zone' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/zones/key={key}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: key + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "zones" + - "key=key" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyZonesKeyByKeyGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Zone' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "zones" + - "key=key" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyZonesKeyByKeyPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Zone' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "zones" + - "key=key" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyZonesKeyByKeyDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Zone' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + /{projectKey}/zones/{ID}: + parameters: + - name: projectKey + in: path + required: true + schema: + type: string + - name: ID + in: path + required: true + schema: + type: string + get: + tags: + - "projectKey" + - "zones" + - "ID" + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyZonesByIDGet + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Zone' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + post: + tags: + - "projectKey" + - "zones" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyZonesByIDPost + parameters: + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZoneUpdate' + + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Zone' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + delete: + tags: + - "projectKey" + - "zones" + - "ID" + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyZonesByIDDelete + parameters: + - name: version + in: query + required: true + style: form + schema: + type: "number" + format: "double" + explode: true + - name: expand + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/Expansion' + explode: true + responses: + 200: + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Zone' + + 409: + description: |- + ## Conflict + + A 409 indicates that the current version of the resource targeted by the request (with the intention to modify or delete it) is different from that provided in the request. + In response to this, the client will usually want to request the newest version of the resource to see what has been changed and decide what changes to apply to the newest version. + + A 409 Conflict indicates a concurrent modification and usually occurs on a versioned resource, which requires the client to provide the version of the resource to perform a change. + + The following general error codes can appear in responses with the HTTP status code `409`: + + * `ConcurrentModification` + The request conflicts with the current state of the involved resource(s). + Typically, the request attempts to modify a resource that is out of date, + i.e. that has been modified by another client since the last time it was retrieved. + The client application should resolve the conflict (with or without involving the end-user) + before retrying the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 400: + description: |- + ## Bad Request + + A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. + Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or + a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned + in the response before re-sending the request. + + The following general error codes can appear in responses with the HTTP status code `400`: + + * `InvalidInput` + Invalid input has been sent to the service. + The client application should validate the input according to the constraints described in the error message + before sending the request. + + * `InvalidOperation` + The resource(s) involved in the request are not in a valid state for the operation. The client application + should validate the constraints described in the error message before sending the request. + + * `InvalidField` + A field has an invalid value. + Extra fields: + * `field` - String + The name of the field. + * `invalidValue` - * + The invalid value. + * `allowedValues` - Array of * - Optional + A fixed set of allowed values for the field, if any. + + * `RequiredField` + A required field is missing a value. + Extra fields: + * `field` - String + The name of the field. + + * `DuplicateField` + A value for a field conflicts with an existing duplicate value. + Extra fields: + * `field` - String + The name of the field. + * `duplicateValue` - * + The offending duplicate value. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 401: + description: |- + ## Unauthorized + + A 401 indicates that the request is not properly authenticated. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 403: + description: |- + ## Forbidden + + A 403 indicates that the authenticated client is not allowed to perform the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 404: + description: |- + ## Not Found + + A 404 indicates that the addressed resource was not found / does not exist. + + The following general error codes can appear in responses with the HTTP status code `404`: + + * `ResourceNotFound` + The resource addressed by the request URL does not exist. + content: {} + 500: + description: |- + ## Internal Server Error + + A 500 indicates that a request failed due to a server-side problem that needs to be resolved before subsequent + requests can succeed. It either indicates a temporary unavailability or permanent server-side problem that needs + to be reported and resolved. + + The following general error codes can appear in responses with the HTTP status code `500`: + + * `General` + A server-side problem occurred that is not further specified. + These errors [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 502: + description: |- + A 502 indicates that a request failed due to a server-side problem caused by platform scaling. + The client application should retry the request with exponential backoff up to a point where further delay is unacceptable. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + 503: + description: |- + ## Service Unavailable + + The following general error codes can appear in responses with the HTTP status code `503`: + + * `OverCapacity` + The service is having trouble handling the load. The client application should retry the request with + exponential backoff up to a point where further delay is unacceptable. + + * `PendingOperation` + A previous conflicting operation is still pending and needs to finish before the request can succeed. + The client application should retry the request with exponential backoff up to a point where further delay + is unaceptable. If these errors persist, [should be reported](http://support.commercetools.com/). + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + +components: + securitySchemes: + oauth_2_0: + type: oauth2 + description: | + HTTP API authorization uses [OAuth2](http://tools.ietf.org/html/rfc6750). + + Clients must obtain an access token from the auth service using one of + the authorization flows described below, before they are able to make authorized requests + to other commercetools services. On successful completion of an authorization flow, + a client will be given an `access_token`, which they need to include in requests + to authorized service endpoints via the HTTP `Authorization` header like this: + + flows: + clientCredentials: + tokenUrl: " " + scopes: + "manage_project:{projectKey}": "" + "manage_products:{projectKey}": "" + "view_products:{projectKey}": "" + "manage_orders:{projectKey}": "" + "manage_orders:{projectKey}:{storeKey}": "" + "view_orders:{projectKey}": "" + "view_orders:{projectKey}:{storeKey}": "" + "manage_customers:{projectKey}": "" + "view_customers:{projectKey}": "" + "manage_payments:{projectKey}": "" + "view_payments:{projectKey}": "" + "manage_subscriptions:{projectKey}": "" + "manage_extensions:{projectKey}": "" + "manage_types:{projectKey}": "" + "view_types:{projectKey}": "" + "view_shopping_lists:{projectKey}": "" + "manage_shopping_lists:{projectKey}": "" + "manage_my_orders:{projectKey}": "" + "manage_my_orders:{projectKey}:{storeKey}": "" + "manage_my_profile:{projectKey}": "" + "view_project_settings:{projectKey}": "" + "view_published_products:{projectKey}": "" + "manage_cart_discounts:{projectKey}": "" + "view_cart_discounts:{projectKey}": "" + "manage_customer_groups:{projectKey}": "" + "view_customer_groups:{projectKey}": "" + "view_shipping_methods:{projectKey}": "" + "manage_shipping_methods:{projectKey}": "" + "manage_tax_categories:{projectKey}": "" + "view_tax_categories:{projectKey}": "" + "manage_categories:{projectKey}": "" + "view_categories:{projectKey}": "" + bearerAuth: + type: http + scheme: bearer + + schemas: + PagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/BaseResource' + meta: + type: "string" + additionalProperties: true + Update: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/UpdateAction' + UpdateAction: + type: "object" + properties: + action: + type: "string" + ApiClient: + type: "object" + properties: + id: + type: "string" + name: + type: "string" + scope: + type: "string" + secret: + type: "string" + lastUsedAt: + type: "string" + format: "date-only" + deleteAt: + type: "string" + format: "datetime" + createdAt: + type: "string" + format: "datetime" + ApiClientDraft: + type: "object" + properties: + name: + type: "string" + scope: + type: "string" + deleteDaysAfterCreation: + type: "integer" + format: "int64" + ApiClientPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/ApiClient' + CartDiscount: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + name: + $ref: '#/components/schemas/LocalizedString' + key: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + value: + $ref: '#/components/schemas/CartDiscountValue' + cartPredicate: + type: "string" + target: + $ref: '#/components/schemas/CartDiscountTarget' + sortOrder: + type: "string" + isActive: + type: "boolean" + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + requiresDiscountCode: + type: "boolean" + references: + type: "array" + items: + $ref: '#/components/schemas/Reference' + stackingMode: + $ref: '#/components/schemas/StackingMode' + custom: + $ref: '#/components/schemas/CustomFields' + CartDiscountCustomLineItemsTarget: + allOf: + - $ref: '#/components/schemas/CartDiscountTarget' + - type: "object" + properties: + type: + type: "string" + predicate: + type: "string" + CartDiscountDraft: + type: "object" + properties: + name: + $ref: '#/components/schemas/LocalizedString' + key: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + value: + $ref: '#/components/schemas/CartDiscountValueDraft' + cartPredicate: + type: "string" + target: + $ref: '#/components/schemas/CartDiscountTarget' + sortOrder: + type: "string" + isActive: + type: "boolean" + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + requiresDiscountCode: + type: "boolean" + stackingMode: + $ref: '#/components/schemas/StackingMode' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + CartDiscountLineItemsTarget: + allOf: + - $ref: '#/components/schemas/CartDiscountTarget' + - type: "object" + properties: + type: + type: "string" + predicate: + type: "string" + CartDiscountPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/CartDiscount' + CartDiscountReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/CartDiscount' + CartDiscountResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + CartDiscountShippingCostTarget: + allOf: + - $ref: '#/components/schemas/CartDiscountTarget' + - type: "object" + properties: + type: + type: "string" + CartDiscountTarget: + type: "object" + discriminator: + propertyName: type + mapping: + customLineItems: '#/components/schemas/CartDiscountCustomLineItemsTarget' + lineItems: '#/components/schemas/CartDiscountLineItemsTarget' + shipping: '#/components/schemas/CartDiscountShippingCostTarget' + multiBuyCustomLineItems: '#/components/schemas/MultiBuyCustomLineItemsTarget' + multiBuyLineItems: '#/components/schemas/MultiBuyLineItemsTarget' + properties: + type: + type: "string" + CartDiscountUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/CartDiscountUpdateAction' + CartDiscountUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + changeCartPredicate: '#/components/schemas/CartDiscountChangeCartPredicateAction' + changeIsActive: '#/components/schemas/CartDiscountChangeIsActiveAction' + changeName: '#/components/schemas/CartDiscountChangeNameAction' + changeRequiresDiscountCode: '#/components/schemas/CartDiscountChangeRequiresDiscountCodeAction' + changeSortOrder: '#/components/schemas/CartDiscountChangeSortOrderAction' + changeStackingMode: '#/components/schemas/CartDiscountChangeStackingModeAction' + changeTarget: '#/components/schemas/CartDiscountChangeTargetAction' + changeValue: '#/components/schemas/CartDiscountChangeValueAction' + setCustomField: '#/components/schemas/CartDiscountSetCustomFieldAction' + setCustomType: '#/components/schemas/CartDiscountSetCustomTypeAction' + setDescription: '#/components/schemas/CartDiscountSetDescriptionAction' + setKey: '#/components/schemas/CartDiscountSetKeyAction' + setValidFrom: '#/components/schemas/CartDiscountSetValidFromAction' + setValidFromAndUntil: '#/components/schemas/CartDiscountSetValidFromAndUntilAction' + setValidUntil: '#/components/schemas/CartDiscountSetValidUntilAction' + properties: + action: + type: "string" + CartDiscountValue: + type: "object" + discriminator: + propertyName: type + mapping: + absolute: '#/components/schemas/CartDiscountValueAbsolute' + fixed: '#/components/schemas/CartDiscountValueFixed' + giftLineItem: '#/components/schemas/CartDiscountValueGiftLineItem' + relative: '#/components/schemas/CartDiscountValueRelative' + properties: + type: + type: "string" + CartDiscountValueAbsolute: + allOf: + - $ref: '#/components/schemas/CartDiscountValue' + - type: "object" + properties: + type: + type: "string" + money: + type: "array" + items: + $ref: '#/components/schemas/TypedMoney' + CartDiscountValueAbsoluteDraft: + allOf: + - $ref: '#/components/schemas/CartDiscountValueDraft' + - type: "object" + properties: + type: + type: "string" + money: + type: "array" + items: + $ref: '#/components/schemas/Money' + CartDiscountValueDraft: + type: "object" + discriminator: + propertyName: type + mapping: + absolute: '#/components/schemas/CartDiscountValueAbsoluteDraft' + fixed: '#/components/schemas/CartDiscountValueFixedDraft' + giftLineItem: '#/components/schemas/CartDiscountValueGiftLineItemDraft' + relative: '#/components/schemas/CartDiscountValueRelativeDraft' + properties: + type: + type: "string" + CartDiscountValueFixed: + allOf: + - $ref: '#/components/schemas/CartDiscountValue' + - type: "object" + properties: + type: + type: "string" + money: + type: "array" + items: + $ref: '#/components/schemas/TypedMoney' + CartDiscountValueFixedDraft: + allOf: + - $ref: '#/components/schemas/CartDiscountValueDraft' + - type: "object" + properties: + type: + type: "string" + money: + type: "array" + items: + $ref: '#/components/schemas/Money' + CartDiscountValueGiftLineItem: + allOf: + - $ref: '#/components/schemas/CartDiscountValue' + - type: "object" + properties: + type: + type: "string" + product: + $ref: '#/components/schemas/ProductReference' + variantId: + type: "integer" + format: "int64" + supplyChannel: + $ref: '#/components/schemas/ChannelReference' + distributionChannel: + $ref: '#/components/schemas/ChannelReference' + CartDiscountValueGiftLineItemDraft: + allOf: + - $ref: '#/components/schemas/CartDiscountValueDraft' + - type: "object" + properties: + type: + type: "string" + product: + $ref: '#/components/schemas/ProductResourceIdentifier' + variantId: + type: "integer" + format: "int64" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + CartDiscountValueRelative: + allOf: + - $ref: '#/components/schemas/CartDiscountValue' + - type: "object" + properties: + type: + type: "string" + permyriad: + type: "integer" + format: "int64" + CartDiscountValueRelativeDraft: + allOf: + - $ref: '#/components/schemas/CartDiscountValueDraft' + - type: "object" + properties: + type: + type: "string" + permyriad: + type: "integer" + format: "int64" + MultiBuyCustomLineItemsTarget: + allOf: + - $ref: '#/components/schemas/CartDiscountTarget' + - type: "object" + properties: + type: + type: "string" + predicate: + type: "string" + triggerQuantity: + type: "integer" + format: "int32" + discountedQuantity: + type: "integer" + format: "int32" + maxOccurrence: + type: "integer" + format: "int32" + selectionMode: + $ref: '#/components/schemas/SelectionMode' + MultiBuyLineItemsTarget: + allOf: + - $ref: '#/components/schemas/CartDiscountTarget' + - type: "object" + properties: + type: + type: "string" + predicate: + type: "string" + triggerQuantity: + type: "integer" + format: "int32" + discountedQuantity: + type: "integer" + format: "int32" + maxOccurrence: + type: "integer" + format: "int32" + selectionMode: + $ref: '#/components/schemas/SelectionMode' + SelectionMode: + type: "string" + enum: + - Cheapest + - MostExpensive + x-annotation-package: "CartDiscount" + StackingMode: + type: "string" + enum: + - Stacking + - StopAfterThisDiscount + x-annotation-package: "CartDiscount" + CartDiscountChangeCartPredicateAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + cartPredicate: + type: "string" + CartDiscountChangeIsActiveAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + isActive: + type: "boolean" + CartDiscountChangeNameAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + CartDiscountChangeRequiresDiscountCodeAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + requiresDiscountCode: + type: "boolean" + CartDiscountChangeSortOrderAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + sortOrder: + type: "string" + CartDiscountChangeStackingModeAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + stackingMode: + $ref: '#/components/schemas/StackingMode' + CartDiscountChangeTargetAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + target: + $ref: '#/components/schemas/CartDiscountTarget' + CartDiscountChangeValueAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + value: + $ref: '#/components/schemas/CartDiscountValueDraft' + CartDiscountSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CartDiscountSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + type: string + additionalProperties: true + CartDiscountSetDescriptionAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + CartDiscountSetKeyAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + CartDiscountSetValidFromAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + validFrom: + type: "string" + format: "datetime" + CartDiscountSetValidFromAndUntilAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + CartDiscountSetValidUntilAction: + allOf: + - $ref: '#/components/schemas/CartDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + validUntil: + type: "string" + format: "datetime" + Cart: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + key: + type: "string" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + customerId: + type: "string" + customerEmail: + type: "string" + anonymousId: + type: "string" + store: + $ref: '#/components/schemas/StoreKeyReference' + lineItems: + type: "array" + items: + $ref: '#/components/schemas/LineItem' + customLineItems: + type: "array" + items: + $ref: '#/components/schemas/CustomLineItem' + totalPrice: + $ref: '#/components/schemas/TypedMoney' + taxedPrice: + $ref: '#/components/schemas/TaxedPrice' + cartState: + $ref: '#/components/schemas/CartState' + shippingAddress: + $ref: '#/components/schemas/Address' + billingAddress: + $ref: '#/components/schemas/Address' + inventoryMode: + $ref: '#/components/schemas/InventoryMode' + taxMode: + $ref: '#/components/schemas/TaxMode' + taxRoundingMode: + $ref: '#/components/schemas/RoundingMode' + taxCalculationMode: + $ref: '#/components/schemas/TaxCalculationMode' + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + country: + $ref: '#/components/schemas/CountryCode' + shippingInfo: + $ref: '#/components/schemas/ShippingInfo' + discountCodes: + type: "array" + items: + $ref: '#/components/schemas/DiscountCodeInfo' + custom: + $ref: '#/components/schemas/CustomFields' + paymentInfo: + $ref: '#/components/schemas/PaymentInfo' + locale: + type: "string" + deleteDaysAfterLastModification: + type: "integer" + format: "int32" + refusedGifts: + type: "array" + items: + $ref: '#/components/schemas/CartDiscountReference' + origin: + $ref: '#/components/schemas/CartOrigin' + shippingRateInput: + $ref: '#/components/schemas/ShippingRateInput' + itemShippingAddresses: + type: "array" + items: + $ref: '#/components/schemas/Address' + CartDraft: + type: "object" + properties: + currency: + $ref: '#/components/schemas/CurrencyCode' + key: + type: "string" + customerId: + type: "string" + customerEmail: + type: "string" + customerGroup: + $ref: '#/components/schemas/CustomerGroupResourceIdentifier' + anonymousId: + type: "string" + store: + $ref: '#/components/schemas/StoreResourceIdentifier' + country: + type: "string" + inventoryMode: + $ref: '#/components/schemas/InventoryMode' + taxMode: + $ref: '#/components/schemas/TaxMode' + taxRoundingMode: + $ref: '#/components/schemas/RoundingMode' + taxCalculationMode: + $ref: '#/components/schemas/TaxCalculationMode' + lineItems: + type: "array" + items: + $ref: '#/components/schemas/LineItemDraft' + customLineItems: + type: "array" + items: + $ref: '#/components/schemas/CustomLineItemDraft' + shippingAddress: + $ref: '#/components/schemas/BaseAddress' + billingAddress: + $ref: '#/components/schemas/BaseAddress' + shippingMethod: + $ref: '#/components/schemas/ShippingMethodResourceIdentifier' + externalTaxRateForShippingMethod: + $ref: '#/components/schemas/ExternalTaxRateDraft' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + locale: + type: "string" + deleteDaysAfterLastModification: + type: "integer" + format: "int64" + origin: + $ref: '#/components/schemas/CartOrigin' + shippingRateInput: + $ref: '#/components/schemas/ShippingRateInputDraft' + itemShippingAddresses: + type: "array" + items: + $ref: '#/components/schemas/BaseAddress' + discountCodes: + type: "array" + items: + type: "string" + CartOrigin: + type: "string" + enum: + - Customer + - Merchant + x-annotation-package: "Cart" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-carts.html#cartorigin" + CartPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Cart' + CartReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/Cart' + CartResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + CartState: + type: "string" + enum: + - Active + - Merged + - Ordered + x-annotation-package: "Cart" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-carts.html#cartstate" + CartUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/CartUpdateAction' + CartUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addCustomLineItem: '#/components/schemas/CartAddCustomLineItemAction' + addDiscountCode: '#/components/schemas/CartAddDiscountCodeAction' + addItemShippingAddress: '#/components/schemas/CartAddItemShippingAddressAction' + addLineItem: '#/components/schemas/CartAddLineItemAction' + addPayment: '#/components/schemas/CartAddPaymentAction' + addShoppingList: '#/components/schemas/CartAddShoppingListAction' + applyDeltaToCustomLineItemShippingDetailsTargets: '#/components/schemas/CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction' + applyDeltaToLineItemShippingDetailsTargets: '#/components/schemas/CartApplyDeltaToLineItemShippingDetailsTargetsAction' + changeCustomLineItemMoney: '#/components/schemas/CartChangeCustomLineItemMoneyAction' + changeCustomLineItemQuantity: '#/components/schemas/CartChangeCustomLineItemQuantityAction' + changeLineItemQuantity: '#/components/schemas/CartChangeLineItemQuantityAction' + changeTaxCalculationMode: '#/components/schemas/CartChangeTaxCalculationModeAction' + changeTaxMode: '#/components/schemas/CartChangeTaxModeAction' + changeTaxRoundingMode: '#/components/schemas/CartChangeTaxRoundingModeAction' + recalculate: '#/components/schemas/CartRecalculateAction' + removeCustomLineItem: '#/components/schemas/CartRemoveCustomLineItemAction' + removeDiscountCode: '#/components/schemas/CartRemoveDiscountCodeAction' + removeItemShippingAddress: '#/components/schemas/CartRemoveItemShippingAddressAction' + removeLineItem: '#/components/schemas/CartRemoveLineItemAction' + removePayment: '#/components/schemas/CartRemovePaymentAction' + setAnonymousId: '#/components/schemas/CartSetAnonymousIdAction' + setBillingAddress: '#/components/schemas/CartSetBillingAddressAction' + setBillingAddressCustomField: '#/components/schemas/CartSetBillingAddressCustomFieldAction' + setBillingAddressCustomType: '#/components/schemas/CartSetBillingAddressCustomTypeAction' + setCartTotalTax: '#/components/schemas/CartSetCartTotalTaxAction' + setCountry: '#/components/schemas/CartSetCountryAction' + setCustomField: '#/components/schemas/CartSetCustomFieldAction' + setCustomLineItemCustomField: '#/components/schemas/CartSetCustomLineItemCustomFieldAction' + setCustomLineItemCustomType: '#/components/schemas/CartSetCustomLineItemCustomTypeAction' + setCustomLineItemShippingDetails: '#/components/schemas/CartSetCustomLineItemShippingDetailsAction' + setCustomLineItemTaxAmount: '#/components/schemas/CartSetCustomLineItemTaxAmountAction' + setCustomLineItemTaxRate: '#/components/schemas/CartSetCustomLineItemTaxRateAction' + setCustomShippingMethod: '#/components/schemas/CartSetCustomShippingMethodAction' + setCustomType: '#/components/schemas/CartSetCustomTypeAction' + setCustomerEmail: '#/components/schemas/CartSetCustomerEmailAction' + setCustomerGroup: '#/components/schemas/CartSetCustomerGroupAction' + setCustomerId: '#/components/schemas/CartSetCustomerIdAction' + setDeleteDaysAfterLastModification: '#/components/schemas/CartSetDeleteDaysAfterLastModificationAction' + setDeliveryAddressCustomField: '#/components/schemas/CartSetDeliveryAddressCustomFieldAction' + setDeliveryAddressCustomType: '#/components/schemas/CartSetDeliveryAddressCustomTypeAction' + setItemShippingAddressCustomField: '#/components/schemas/CartSetItemShippingAddressCustomFieldAction' + setItemShippingAddressCustomType: '#/components/schemas/CartSetItemShippingAddressCustomTypeAction' + setKey: '#/components/schemas/CartSetKeyAction' + setLineItemCustomField: '#/components/schemas/CartSetLineItemCustomFieldAction' + setLineItemCustomType: '#/components/schemas/CartSetLineItemCustomTypeAction' + setLineItemDistributionChannel: '#/components/schemas/CartSetLineItemDistributionChannelAction' + setLineItemPrice: '#/components/schemas/CartSetLineItemPriceAction' + setLineItemShippingDetails: '#/components/schemas/CartSetLineItemShippingDetailsAction' + setLineItemSupplyChannel: '#/components/schemas/CartSetLineItemSupplyChannelAction' + setLineItemTaxAmount: '#/components/schemas/CartSetLineItemTaxAmountAction' + setLineItemTaxRate: '#/components/schemas/CartSetLineItemTaxRateAction' + setLineItemTotalPrice: '#/components/schemas/CartSetLineItemTotalPriceAction' + setLocale: '#/components/schemas/CartSetLocaleAction' + setShippingAddress: '#/components/schemas/CartSetShippingAddressAction' + setShippingAddressCustomField: '#/components/schemas/CartSetShippingAddressCustomFieldAction' + setShippingAddressCustomType: '#/components/schemas/CartSetShippingAddressCustomTypeAction' + setShippingMethod: '#/components/schemas/CartSetShippingMethodAction' + setShippingMethodTaxAmount: '#/components/schemas/CartSetShippingMethodTaxAmountAction' + setShippingMethodTaxRate: '#/components/schemas/CartSetShippingMethodTaxRateAction' + setShippingRateInput: '#/components/schemas/CartSetShippingRateInputAction' + updateItemShippingAddress: '#/components/schemas/CartUpdateItemShippingAddressAction' + properties: + action: + type: "string" + ClassificationShippingRateInput: + allOf: + - $ref: '#/components/schemas/ShippingRateInput' + - type: "object" + properties: + type: + type: "string" + key: + type: "string" + label: + $ref: '#/components/schemas/LocalizedString' + ClassificationShippingRateInputDraft: + allOf: + - $ref: '#/components/schemas/ShippingRateInputDraft' + - type: "object" + properties: + type: + type: "string" + key: + type: "string" + CustomLineItem: + type: "object" + properties: + id: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + money: + $ref: '#/components/schemas/TypedMoney' + taxedPrice: + $ref: '#/components/schemas/TaxedItemPrice' + totalPrice: + $ref: '#/components/schemas/TypedMoney' + slug: + type: "string" + quantity: + type: "integer" + format: "int64" + state: + type: "array" + items: + $ref: '#/components/schemas/ItemState' + taxCategory: + $ref: '#/components/schemas/TaxCategoryReference' + taxRate: + $ref: '#/components/schemas/TaxRate' + discountedPricePerQuantity: + type: "array" + items: + $ref: '#/components/schemas/DiscountedLineItemPriceForQuantity' + custom: + $ref: '#/components/schemas/CustomFields' + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetails' + CustomLineItemDraft: + type: "object" + properties: + name: + $ref: '#/components/schemas/LocalizedString' + quantity: + type: "integer" + format: "int64" + money: + $ref: '#/components/schemas/Money' + slug: + type: "string" + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + DiscountCodeInfo: + type: "object" + properties: + discountCode: + $ref: '#/components/schemas/DiscountCodeReference' + state: + $ref: '#/components/schemas/DiscountCodeState' + DiscountCodeState: + type: "string" + enum: + - NotActive + - DoesNotMatchCart + - MatchesCart + - MaxApplicationReached + - ApplicationStoppedByPreviousDiscount + - NotValid + x-annotation-package: "Cart" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-carts.html#discountcodestate" + DiscountedLineItemPortion: + type: "object" + properties: + discount: + $ref: '#/components/schemas/CartDiscountReference' + discountedAmount: + $ref: '#/components/schemas/TypedMoney' + DiscountedLineItemPrice: + type: "object" + properties: + value: + $ref: '#/components/schemas/TypedMoney' + includedDiscounts: + type: "array" + items: + $ref: '#/components/schemas/DiscountedLineItemPortion' + DiscountedLineItemPriceForQuantity: + type: "object" + properties: + quantity: + type: "number" + format: "double" + discountedPrice: + $ref: '#/components/schemas/DiscountedLineItemPrice' + ExternalLineItemTotalPrice: + type: "object" + properties: + price: + $ref: '#/components/schemas/Money' + totalPrice: + $ref: '#/components/schemas/Money' + ExternalTaxAmountDraft: + type: "object" + properties: + totalGross: + $ref: '#/components/schemas/Money' + taxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + ExternalTaxRateDraft: + type: "object" + properties: + name: + type: "string" + amount: + type: "number" + format: "double" + country: + type: "string" + state: + type: "string" + subRates: + type: "array" + items: + $ref: '#/components/schemas/SubRate' + includedInPrice: + type: "boolean" + InventoryMode: + type: "string" + enum: + - TrackOnly + - ReserveOnOrder + - None + x-annotation-package: "Cart" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-carts.html#inventorymode" + ItemShippingDetails: + type: "object" + properties: + targets: + type: "array" + items: + $ref: '#/components/schemas/ItemShippingTarget' + valid: + type: "boolean" + ItemShippingDetailsDraft: + type: "object" + properties: + targets: + type: "array" + items: + $ref: '#/components/schemas/ItemShippingTarget' + ItemShippingTarget: + type: "object" + properties: + addressKey: + type: "string" + quantity: + type: "number" + format: "double" + LineItem: + type: "object" + properties: + id: + type: "string" + productId: + type: "string" + productKey: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + productSlug: + $ref: '#/components/schemas/LocalizedString' + productType: + $ref: '#/components/schemas/ProductTypeReference' + variant: + $ref: '#/components/schemas/ProductVariant' + price: + $ref: '#/components/schemas/Price' + taxedPrice: + $ref: '#/components/schemas/TaxedItemPrice' + totalPrice: + $ref: '#/components/schemas/TypedMoney' + quantity: + type: "integer" + format: "int64" + addedAt: + type: "string" + format: "datetime" + state: + type: "array" + items: + $ref: '#/components/schemas/ItemState' + taxRate: + $ref: '#/components/schemas/TaxRate' + supplyChannel: + $ref: '#/components/schemas/ChannelReference' + distributionChannel: + $ref: '#/components/schemas/ChannelReference' + discountedPricePerQuantity: + type: "array" + items: + $ref: '#/components/schemas/DiscountedLineItemPriceForQuantity' + priceMode: + $ref: '#/components/schemas/LineItemPriceMode' + lineItemMode: + $ref: '#/components/schemas/LineItemMode' + custom: + $ref: '#/components/schemas/CustomFields' + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetails' + lastModifiedAt: + type: "string" + format: "datetime" + LineItemDraft: + type: "object" + properties: + productId: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + quantity: + type: "integer" + format: "int64" + addedAt: + type: "string" + format: "datetime" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + externalPrice: + $ref: '#/components/schemas/Money' + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + LineItemMode: + type: "string" + enum: + - Standard + - GiftLineItem + x-annotation-package: "Cart" + LineItemPriceMode: + type: "string" + enum: + - Platform + - ExternalTotal + - ExternalPrice + x-annotation-package: "Cart" + ReplicaCartDraft: + type: "object" + properties: + reference: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + key: + type: "string" + RoundingMode: + type: "string" + enum: + - HalfEven + - HalfUp + - HalfDown + x-annotation-package: "Cart" + ScoreShippingRateInput: + allOf: + - $ref: '#/components/schemas/ShippingRateInput' + - type: "object" + properties: + type: + type: "string" + score: + type: "number" + format: "double" + ScoreShippingRateInputDraft: + allOf: + - $ref: '#/components/schemas/ShippingRateInputDraft' + - type: "object" + properties: + type: + type: "string" + score: + type: "number" + format: "double" + ShippingInfo: + type: "object" + properties: + shippingMethodName: + type: "string" + price: + $ref: '#/components/schemas/TypedMoney' + shippingRate: + $ref: '#/components/schemas/ShippingRate' + taxedPrice: + $ref: '#/components/schemas/TaxedItemPrice' + taxRate: + $ref: '#/components/schemas/TaxRate' + taxCategory: + $ref: '#/components/schemas/TaxCategoryReference' + shippingMethod: + $ref: '#/components/schemas/ShippingMethodReference' + deliveries: + type: "array" + items: + $ref: '#/components/schemas/Delivery' + discountedPrice: + $ref: '#/components/schemas/DiscountedLineItemPrice' + shippingMethodState: + $ref: '#/components/schemas/ShippingMethodState' + ShippingMethodState: + type: "string" + enum: + - DoesNotMatchCart + - MatchesCart + x-annotation-package: "Cart" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-carts.html#shippingmethodstate" + ShippingRateInput: + type: "object" + discriminator: + propertyName: type + mapping: + Classification: '#/components/schemas/ClassificationShippingRateInput' + Score: '#/components/schemas/ScoreShippingRateInput' + properties: + type: + type: "string" + ShippingRateInputDraft: + type: "object" + discriminator: + propertyName: type + mapping: + Classification: '#/components/schemas/ClassificationShippingRateInputDraft' + Score: '#/components/schemas/ScoreShippingRateInputDraft' + properties: + type: + type: "string" + TaxCalculationMode: + type: "string" + enum: + - LineItemLevel + - UnitPriceLevel + x-annotation-package: "Cart" + TaxMode: + type: "string" + enum: + - Platform + - External + - ExternalAmount + - Disabled + x-annotation-package: "Cart" + TaxPortion: + type: "object" + properties: + name: + type: "string" + rate: + type: "number" + format: "double" + amount: + $ref: '#/components/schemas/TypedMoney' + TaxPortionDraft: + type: "object" + properties: + name: + type: "string" + rate: + type: "number" + format: "double" + amount: + $ref: '#/components/schemas/Money' + TaxedItemPrice: + type: "object" + properties: + totalNet: + $ref: '#/components/schemas/TypedMoney' + totalGross: + $ref: '#/components/schemas/TypedMoney' + TaxedPrice: + type: "object" + properties: + totalNet: + $ref: '#/components/schemas/TypedMoney' + totalGross: + $ref: '#/components/schemas/TypedMoney' + taxPortions: + type: "array" + items: + $ref: '#/components/schemas/TaxPortion' + TaxedPriceDraft: + type: "object" + properties: + totalNet: + $ref: '#/components/schemas/Money' + totalGross: + $ref: '#/components/schemas/Money' + taxPortions: + type: "array" + items: + $ref: '#/components/schemas/TaxPortionDraft' + CartAddCustomLineItemAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + money: + $ref: '#/components/schemas/Money' + name: + $ref: '#/components/schemas/LocalizedString' + quantity: + type: "integer" + format: "int64" + slug: + type: "string" + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + CartAddDiscountCodeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + code: + type: "string" + CartAddItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + CartAddLineItemAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + productId: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + quantity: + type: "integer" + format: "int64" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + externalPrice: + $ref: '#/components/schemas/Money' + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + CartAddPaymentAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + payment: + $ref: '#/components/schemas/PaymentResourceIdentifier' + CartAddShoppingListAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + shoppingList: + $ref: '#/components/schemas/ShoppingListResourceIdentifier' + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + targetsDelta: + type: "array" + items: + $ref: '#/components/schemas/ItemShippingTarget' + CartApplyDeltaToLineItemShippingDetailsTargetsAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + targetsDelta: + type: "array" + items: + $ref: '#/components/schemas/ItemShippingTarget' + CartChangeCustomLineItemMoneyAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + money: + $ref: '#/components/schemas/Money' + CartChangeCustomLineItemQuantityAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + CartChangeLineItemQuantityAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + externalPrice: + $ref: '#/components/schemas/Money' + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + CartChangeTaxCalculationModeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxCalculationMode: + $ref: '#/components/schemas/TaxCalculationMode' + CartChangeTaxModeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxMode: + $ref: '#/components/schemas/TaxMode' + CartChangeTaxRoundingModeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxRoundingMode: + $ref: '#/components/schemas/RoundingMode' + CartRecalculateAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + updateProductData: + type: "boolean" + CartRemoveCustomLineItemAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + CartRemoveDiscountCodeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + discountCode: + $ref: '#/components/schemas/DiscountCodeReference' + CartRemoveItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressKey: + type: "string" + CartRemoveLineItemAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + externalPrice: + $ref: '#/components/schemas/Money' + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + shippingDetailsToRemove: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + CartRemovePaymentAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + payment: + $ref: '#/components/schemas/PaymentResourceIdentifier' + CartSetAnonymousIdAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + anonymousId: + type: "string" + CartSetBillingAddressAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + CartSetBillingAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CartSetBillingAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + CartSetCartTotalTaxAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + externalTotalGross: + $ref: '#/components/schemas/Money' + externalTaxPortions: + type: "array" + items: + $ref: '#/components/schemas/TaxPortionDraft' + CartSetCountryAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + country: + $ref: '#/components/schemas/CountryCode' + CartSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: string + - type: "number" + - type: "integer" + - type: "boolean" + CartSetCustomLineItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CartSetCustomLineItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + CartSetCustomLineItemShippingDetailsAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + CartSetCustomLineItemTaxAmountAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + externalTaxAmount: + $ref: '#/components/schemas/ExternalTaxAmountDraft' + CartSetCustomLineItemTaxRateAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + CartSetCustomShippingMethodAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + shippingMethodName: + type: "string" + shippingRate: + $ref: '#/components/schemas/ShippingRateDraft' + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + CartSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + CartSetCustomerEmailAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + email: + type: "string" + CartSetCustomerGroupAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + customerGroup: + $ref: '#/components/schemas/CustomerGroupResourceIdentifier' + CartSetCustomerIdAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + customerId: + type: "string" + CartSetDeleteDaysAfterLastModificationAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + deleteDaysAfterLastModification: + type: "integer" + format: "int32" + CartSetDeliveryAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CartSetDeliveryAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + CartSetItemShippingAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressKey: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CartSetItemShippingAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressKey: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + CartSetKeyAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + CartSetLineItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CartSetLineItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + CartSetLineItemDistributionChannelAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + CartSetLineItemPriceAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + externalPrice: + $ref: '#/components/schemas/Money' + CartSetLineItemShippingDetailsAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + CartSetLineItemSupplyChannelAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + CartSetLineItemTaxAmountAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + externalTaxAmount: + $ref: '#/components/schemas/ExternalTaxAmountDraft' + CartSetLineItemTaxRateAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + CartSetLineItemTotalPriceAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + CartSetLocaleAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + locale: + type: "string" + CartSetShippingAddressAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + CartSetShippingAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CartSetShippingAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + CartSetShippingMethodAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + shippingMethod: + $ref: '#/components/schemas/ShippingMethodResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + CartSetShippingMethodTaxAmountAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + externalTaxAmount: + $ref: '#/components/schemas/ExternalTaxAmountDraft' + CartSetShippingMethodTaxRateAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + CartSetShippingRateInputAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + shippingRateInput: + $ref: '#/components/schemas/ShippingRateInputDraft' + CartUpdateItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/CartUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + Category: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + name: + $ref: '#/components/schemas/LocalizedString' + slug: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + ancestors: + type: "array" + items: + $ref: '#/components/schemas/CategoryReference' + parent: + $ref: '#/components/schemas/CategoryReference' + orderHint: + type: "string" + externalId: + type: "string" + metaTitle: + $ref: '#/components/schemas/LocalizedString' + metaDescription: + $ref: '#/components/schemas/LocalizedString' + metaKeywords: + $ref: '#/components/schemas/LocalizedString' + custom: + $ref: '#/components/schemas/CustomFields' + assets: + type: "array" + items: + $ref: '#/components/schemas/Asset' + key: + type: "string" + CategoryDraft: + type: "object" + properties: + name: + $ref: '#/components/schemas/LocalizedString' + slug: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + parent: + $ref: '#/components/schemas/CategoryResourceIdentifier' + orderHint: + type: "string" + externalId: + type: "string" + metaTitle: + $ref: '#/components/schemas/LocalizedString' + metaDescription: + $ref: '#/components/schemas/LocalizedString' + metaKeywords: + $ref: '#/components/schemas/LocalizedString' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + assets: + type: "array" + items: + $ref: '#/components/schemas/AssetDraft' + key: + type: "string" + CategoryPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Category' + CategoryReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/Category' + CategoryResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + CategoryUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/CategoryUpdateAction' + CategoryUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addAsset: '#/components/schemas/CategoryAddAssetAction' + changeAssetName: '#/components/schemas/CategoryChangeAssetNameAction' + changeAssetOrder: '#/components/schemas/CategoryChangeAssetOrderAction' + changeName: '#/components/schemas/CategoryChangeNameAction' + changeOrderHint: '#/components/schemas/CategoryChangeOrderHintAction' + changeParent: '#/components/schemas/CategoryChangeParentAction' + changeSlug: '#/components/schemas/CategoryChangeSlugAction' + removeAsset: '#/components/schemas/CategoryRemoveAssetAction' + setAssetCustomField: '#/components/schemas/CategorySetAssetCustomFieldAction' + setAssetCustomType: '#/components/schemas/CategorySetAssetCustomTypeAction' + setAssetDescription: '#/components/schemas/CategorySetAssetDescriptionAction' + setAssetKey: '#/components/schemas/CategorySetAssetKeyAction' + setAssetSources: '#/components/schemas/CategorySetAssetSourcesAction' + setAssetTags: '#/components/schemas/CategorySetAssetTagsAction' + setCustomField: '#/components/schemas/CategorySetCustomFieldAction' + setCustomType: '#/components/schemas/CategorySetCustomTypeAction' + setDescription: '#/components/schemas/CategorySetDescriptionAction' + setExternalId: '#/components/schemas/CategorySetExternalIdAction' + setKey: '#/components/schemas/CategorySetKeyAction' + setMetaDescription: '#/components/schemas/CategorySetMetaDescriptionAction' + setMetaKeywords: '#/components/schemas/CategorySetMetaKeywordsAction' + setMetaTitle: '#/components/schemas/CategorySetMetaTitleAction' + properties: + action: + type: "string" + CategoryAddAssetAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + asset: + $ref: '#/components/schemas/AssetDraft' + position: + type: "integer" + format: "int32" + CategoryChangeAssetNameAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + assetId: + type: "string" + assetKey: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + CategoryChangeAssetOrderAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + assetOrder: + type: "array" + items: + type: "string" + CategoryChangeNameAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + CategoryChangeOrderHintAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + orderHint: + type: "string" + CategoryChangeParentAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + parent: + $ref: '#/components/schemas/CategoryResourceIdentifier' + CategoryChangeSlugAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + slug: + $ref: '#/components/schemas/LocalizedString' + CategoryRemoveAssetAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + assetId: + type: "string" + assetKey: + type: "string" + CategorySetAssetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + assetId: + type: "string" + assetKey: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CategorySetAssetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + assetId: + type: "string" + assetKey: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + type: "string" + additionalProperties: true + CategorySetAssetDescriptionAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + assetId: + type: "string" + assetKey: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + CategorySetAssetKeyAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + assetId: + type: "string" + assetKey: + type: "string" + CategorySetAssetSourcesAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + assetId: + type: "string" + assetKey: + type: "string" + sources: + type: "array" + items: + $ref: '#/components/schemas/AssetSource' + CategorySetAssetTagsAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + assetId: + type: "string" + assetKey: + type: "string" + tags: + type: "array" + items: + type: "string" + CategorySetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CategorySetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + CategorySetDescriptionAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + CategorySetExternalIdAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + externalId: + type: "string" + CategorySetKeyAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + CategorySetMetaDescriptionAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + metaDescription: + $ref: '#/components/schemas/LocalizedString' + CategorySetMetaKeywordsAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + metaKeywords: + $ref: '#/components/schemas/LocalizedString' + CategorySetMetaTitleAction: + allOf: + - $ref: '#/components/schemas/CategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + metaTitle: + $ref: '#/components/schemas/LocalizedString' + Channel: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + roles: + type: "array" + items: + $ref: '#/components/schemas/ChannelRoleEnum' + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + address: + $ref: '#/components/schemas/Address' + reviewRatingStatistics: + $ref: '#/components/schemas/ReviewRatingStatistics' + custom: + $ref: '#/components/schemas/CustomFields' + geoLocation: + $ref: '#/components/schemas/GeoJson' + ChannelDraft: + type: "object" + properties: + key: + type: "string" + roles: + type: "array" + items: + $ref: '#/components/schemas/ChannelRoleEnum' + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + address: + $ref: '#/components/schemas/BaseAddress' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + geoLocation: + $ref: '#/components/schemas/GeoJson' + ChannelPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Channel' + ChannelReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/Channel' + ChannelResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + ChannelRoleEnum: + type: "string" + enum: + - InventorySupply + - ProductDistribution + - OrderExport + - OrderImport + - Primary + x-annotation-package: "Channel" + x-annotation-docs-uri: "https://docs.commercetools.com/api/projects/channels#channelroleenum" + x-annotation-enumDescriptions: + InventorySupply: "Channel can be used to track inventory entries (for example, Channels + with this role can be treated as warehouses).n" + ProductDistribution: "Channel can be used to expose Products to a specific distribution + Channel.nThe Channel can be used by a Cart to [select](/../api/projects/carts#lineitem-price-selection) + a Product Price.n" + OrderExport: "Channel can be used to track order export activities.n" + OrderImport: "Channel can be used to track order import activities.n" + Primary: "This role can be combined with the other roles (for example, with `InventorySupply`). + If used, the Channel is considered as the primary or main channel among Channels + of the same type.n" + ChannelUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/ChannelUpdateAction' + ChannelUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addRoles: '#/components/schemas/ChannelAddRolesAction' + changeDescription: '#/components/schemas/ChannelChangeDescriptionAction' + changeKey: '#/components/schemas/ChannelChangeKeyAction' + changeName: '#/components/schemas/ChannelChangeNameAction' + removeRoles: '#/components/schemas/ChannelRemoveRolesAction' + setAddress: '#/components/schemas/ChannelSetAddressAction' + setAddressCustomField: '#/components/schemas/ChannelSetAddressCustomFieldAction' + setAddressCustomType: '#/components/schemas/ChannelSetAddressCustomTypeAction' + setCustomField: '#/components/schemas/ChannelSetCustomFieldAction' + setCustomType: '#/components/schemas/ChannelSetCustomTypeAction' + setGeoLocation: '#/components/schemas/ChannelSetGeoLocationAction' + setRoles: '#/components/schemas/ChannelSetRolesAction' + properties: + action: + type: "string" + ChannelAddRolesAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + roles: + type: "array" + items: + $ref: '#/components/schemas/ChannelRoleEnum' + ChannelChangeDescriptionAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + ChannelChangeKeyAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + ChannelChangeNameAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + ChannelRemoveRolesAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + roles: + type: "array" + items: + $ref: '#/components/schemas/ChannelRoleEnum' + ChannelSetAddressAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + ChannelSetAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + ChannelSetAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + ChannelSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + ChannelSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + ChannelSetGeoLocationAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + geoLocation: + $ref: '#/components/schemas/GeoJson' + ChannelSetRolesAction: + allOf: + - $ref: '#/components/schemas/ChannelUpdateAction' + - type: "object" + properties: + action: + type: "string" + roles: + type: "array" + items: + $ref: '#/components/schemas/ChannelRoleEnum' + Address: + allOf: + - $ref: '#/components/schemas/BaseAddress' + - type: "object" + properties: + id: + type: "string" + key: + type: "string" + title: + type: "string" + salutation: + type: "string" + firstName: + type: "string" + lastName: + type: "string" + streetName: + type: "string" + streetNumber: + type: "string" + additionalStreetInfo: + type: "string" + postalCode: + type: "string" + city: + type: "string" + region: + type: "string" + state: + type: "string" + country: + $ref: '#/components/schemas/CountryCode' + company: + type: "string" + department: + type: "string" + building: + type: "string" + apartment: + type: "string" + pOBox: + type: "string" + phone: + type: "string" + mobile: + type: "string" + email: + type: "string" + fax: + type: "string" + additionalAddressInfo: + type: "string" + externalId: + type: "string" + custom: + $ref: '#/components/schemas/CustomFields' + AddressDraft: + allOf: + - $ref: '#/components/schemas/BaseAddress' + - type: "object" + properties: + id: + type: "string" + key: + type: "string" + title: + type: "string" + salutation: + type: "string" + firstName: + type: "string" + lastName: + type: "string" + streetName: + type: "string" + streetNumber: + type: "string" + additionalStreetInfo: + type: "string" + postalCode: + type: "string" + city: + type: "string" + region: + type: "string" + state: + type: "string" + country: + $ref: '#/components/schemas/CountryCode' + company: + type: "string" + department: + type: "string" + building: + type: "string" + apartment: + type: "string" + pOBox: + type: "string" + phone: + type: "string" + mobile: + type: "string" + email: + type: "string" + fax: + type: "string" + additionalAddressInfo: + type: "string" + externalId: + type: "string" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + Asset: + type: "object" + properties: + id: + type: "string" + sources: + type: "array" + items: + $ref: '#/components/schemas/AssetSource' + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + tags: + type: "array" + items: + type: "string" + custom: + $ref: '#/components/schemas/CustomFields' + key: + type: "string" + AssetDimensions: + type: "object" + properties: + w: + type: "integer" + format: "int32" + h: + type: "integer" + format: "int32" + AssetDraft: + type: "object" + properties: + sources: + type: "array" + items: + $ref: '#/components/schemas/AssetSource' + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + tags: + type: "array" + items: + type: "string" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + key: + type: "string" + AssetSource: + type: "object" + properties: + uri: + type: "string" + key: + type: "string" + dimensions: + $ref: '#/components/schemas/AssetDimensions' + contentType: + type: "string" + BaseAddress: + type: "object" + properties: + id: + type: "string" + key: + type: "string" + title: + type: "string" + salutation: + type: "string" + firstName: + type: "string" + lastName: + type: "string" + streetName: + type: "string" + streetNumber: + type: "string" + additionalStreetInfo: + type: "string" + postalCode: + type: "string" + city: + type: "string" + region: + type: "string" + state: + type: "string" + country: + $ref: '#/components/schemas/CountryCode' + company: + type: "string" + department: + type: "string" + building: + type: "string" + apartment: + type: "string" + pOBox: + type: "string" + phone: + type: "string" + mobile: + type: "string" + email: + type: "string" + fax: + type: "string" + additionalAddressInfo: + type: "string" + externalId: + type: "string" + BaseResource: + type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + CentPrecisionMoney: + allOf: + - $ref: '#/components/schemas/TypedMoney' + - type: "object" + properties: + type: + $ref: '#/components/schemas/MoneyType' + fractionDigits: + type: "integer" + format: "int32" + centAmount: + type: "integer" + format: "int64" + currencyCode: + $ref: '#/components/schemas/CurrencyCode' + CentPrecisionMoneyDraft: + allOf: + - $ref: '#/components/schemas/TypedMoneyDraft' + - type: "object" + properties: + centAmount: + type: "integer" + format: "int64" + currencyCode: + $ref: '#/components/schemas/CurrencyCode' + type: + $ref: '#/components/schemas/MoneyType' + fractionDigits: + type: "integer" + format: "int32" + ClientLogging: + type: "object" + properties: + clientId: + type: "string" + externalUserId: + type: "string" + customer: + $ref: '#/components/schemas/CustomerReference' + anonymousId: + type: "string" + CountryCode: + type: "string" + CreatedBy: + allOf: + - $ref: '#/components/schemas/ClientLogging' + - type: "object" + properties: + clientId: + type: "string" + externalUserId: + type: "string" + customer: + $ref: '#/components/schemas/CustomerReference' + anonymousId: + type: "string" + CurrencyCode: + type: "string" + DiscountedPrice: + type: "object" + properties: + value: + $ref: '#/components/schemas/TypedMoney' + discount: + $ref: '#/components/schemas/ProductDiscountReference' + DiscountedPriceDraft: + type: "object" + properties: + value: + $ref: '#/components/schemas/Money' + discount: + $ref: '#/components/schemas/ProductDiscountReference' + Expansion: + type: "string" + GeoJson: + type: "object" + discriminator: + propertyName: type + mapping: + Point: '#/components/schemas/GeoJsonPoint' + properties: + type: + type: "string" + GeoJsonPoint: + allOf: + - $ref: '#/components/schemas/GeoJson' + - type: "object" + properties: + type: + type: "string" + coordinates: + type: "array" + items: + type: "number" + format: "double" + HighPrecisionMoney: + allOf: + - $ref: '#/components/schemas/TypedMoney' + - type: "object" + properties: + type: + $ref: '#/components/schemas/MoneyType' + fractionDigits: + type: "integer" + format: "int32" + centAmount: + type: "integer" + format: "int64" + currencyCode: + $ref: '#/components/schemas/CurrencyCode' + preciseAmount: + type: "integer" + format: "int64" + HighPrecisionMoneyDraft: + allOf: + - $ref: '#/components/schemas/TypedMoneyDraft' + - type: "object" + properties: + centAmount: + type: "integer" + format: "int64" + currencyCode: + $ref: '#/components/schemas/CurrencyCode' + type: + $ref: '#/components/schemas/MoneyType' + fractionDigits: + type: "integer" + format: "int32" + preciseAmount: + type: "integer" + format: "int64" + Image: + type: "object" + properties: + url: + type: "string" + dimensions: + $ref: '#/components/schemas/ImageDimensions' + label: + type: "string" + ImageDimensions: + type: "object" + properties: + w: + type: "integer" + format: "int32" + h: + type: "integer" + format: "int32" + KeyReference: + type: "object" + discriminator: + propertyName: typeId + mapping: + store: '#/components/schemas/StoreKeyReference' + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + key: + type: "string" + LastModifiedBy: + allOf: + - $ref: '#/components/schemas/ClientLogging' + - type: "object" + properties: + clientId: + type: "string" + externalUserId: + type: "string" + customer: + $ref: '#/components/schemas/CustomerReference' + anonymousId: + type: "string" + Locale: + type: "string" + LocalizedString: + type: "object" + additionalProperties: + type: "string" + Money: + type: "object" + properties: + centAmount: + type: "integer" + format: "int64" + currencyCode: + $ref: '#/components/schemas/CurrencyCode' + MoneyType: + type: "string" + enum: + - centPrecision + - highPrecision + x-annotation-package: "Common" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-types.html#money" + Price: + type: "object" + properties: + id: + type: "string" + value: + $ref: '#/components/schemas/TypedMoney' + country: + $ref: '#/components/schemas/CountryCode' + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + channel: + $ref: '#/components/schemas/ChannelReference' + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + discounted: + $ref: '#/components/schemas/DiscountedPrice' + custom: + $ref: '#/components/schemas/CustomFields' + tiers: + type: "array" + items: + $ref: '#/components/schemas/PriceTier' + PriceDraft: + type: "object" + properties: + value: + $ref: '#/components/schemas/Money' + country: + $ref: '#/components/schemas/CountryCode' + customerGroup: + $ref: '#/components/schemas/CustomerGroupResourceIdentifier' + channel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + tiers: + type: "array" + items: + $ref: '#/components/schemas/PriceTierDraft' + discounted: + $ref: '#/components/schemas/DiscountedPriceDraft' + PriceTier: + type: "object" + properties: + minimumQuantity: + type: "integer" + format: "int64" + value: + $ref: '#/components/schemas/TypedMoney' + PriceTierDraft: + type: "object" + properties: + minimumQuantity: + type: "integer" + format: "int64" + value: + $ref: '#/components/schemas/Money' + QueryPredicate: + type: "string" + QueryPrice: + type: "object" + properties: + id: + type: "string" + value: + $ref: '#/components/schemas/Money' + country: + $ref: '#/components/schemas/CountryCode' + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + channel: + $ref: '#/components/schemas/ChannelReference' + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + discounted: + $ref: '#/components/schemas/DiscountedPriceDraft' + custom: + $ref: '#/components/schemas/CustomFields' + tiers: + type: "array" + items: + $ref: '#/components/schemas/PriceTierDraft' + Reference: + type: "object" + discriminator: + propertyName: typeId + mapping: + cart-discount: '#/components/schemas/CartDiscountReference' + cart: '#/components/schemas/CartReference' + category: '#/components/schemas/CategoryReference' + channel: '#/components/schemas/ChannelReference' + key-value-document: '#/components/schemas/CustomObjectReference' + customer-group: '#/components/schemas/CustomerGroupReference' + customer: '#/components/schemas/CustomerReference' + discount-code: '#/components/schemas/DiscountCodeReference' + inventory-entry: '#/components/schemas/InventoryEntryReference' + order-edit: '#/components/schemas/OrderEditReference' + order: '#/components/schemas/OrderReference' + payment: '#/components/schemas/PaymentReference' + product-discount: '#/components/schemas/ProductDiscountReference' + product: '#/components/schemas/ProductReference' + product-selection: '#/components/schemas/ProductSelectionReference' + product-type: '#/components/schemas/ProductTypeReference' + review: '#/components/schemas/ReviewReference' + shipping-method: '#/components/schemas/ShippingMethodReference' + shopping-list: '#/components/schemas/ShoppingListReference' + state: '#/components/schemas/StateReference' + store: '#/components/schemas/StoreReference' + tax-category: '#/components/schemas/TaxCategoryReference' + type: '#/components/schemas/TypeReference' + zone: '#/components/schemas/ZoneReference' + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + ReferenceTypeId: + type: "string" + enum: + - cart + - cart-discount + - category + - channel + - customer + - customer-email-token + - customer-group + - customer-password-token + - discount-code + - extension + - inventory-entry + - key-value-document + - order + - order-edit + - payment + - product + - product-discount + - product-selection + - product-type + - review + - shipping-method + - shopping-list + - state + - store + - subscription + - tax-category + - type + - zone + x-annotation-package: "Common" + ResourceIdentifier: + type: "object" + discriminator: + propertyName: typeId + mapping: + cart-discount: '#/components/schemas/CartDiscountResourceIdentifier' + cart: '#/components/schemas/CartResourceIdentifier' + category: '#/components/schemas/CategoryResourceIdentifier' + channel: '#/components/schemas/ChannelResourceIdentifier' + customer-group: '#/components/schemas/CustomerGroupResourceIdentifier' + customer: '#/components/schemas/CustomerResourceIdentifier' + discount-code: '#/components/schemas/DiscountCodeResourceIdentifier' + inventory-entry: '#/components/schemas/InventoryEntryResourceIdentifier' + order-edit: '#/components/schemas/OrderEditResourceIdentifier' + order: '#/components/schemas/OrderResourceIdentifier' + payment: '#/components/schemas/PaymentResourceIdentifier' + product-discount: '#/components/schemas/ProductDiscountResourceIdentifier' + product: '#/components/schemas/ProductResourceIdentifier' + product-selection: '#/components/schemas/ProductSelectionResourceIdentifier' + product-type: '#/components/schemas/ProductTypeResourceIdentifier' + review: '#/components/schemas/ReviewResourceIdentifier' + shipping-method: '#/components/schemas/ShippingMethodResourceIdentifier' + shopping-list: '#/components/schemas/ShoppingListResourceIdentifier' + state: '#/components/schemas/StateResourceIdentifier' + store: '#/components/schemas/StoreResourceIdentifier' + tax-category: '#/components/schemas/TaxCategoryResourceIdentifier' + type: '#/components/schemas/TypeResourceIdentifier' + zone: '#/components/schemas/ZoneResourceIdentifier' + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + ScopedPrice: + type: "object" + properties: + id: + type: "string" + value: + $ref: '#/components/schemas/TypedMoney' + currentValue: + $ref: '#/components/schemas/TypedMoney' + country: + $ref: '#/components/schemas/CountryCode' + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + channel: + $ref: '#/components/schemas/ChannelReference' + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + discounted: + $ref: '#/components/schemas/DiscountedPrice' + custom: + $ref: '#/components/schemas/CustomFields' + Sort: + type: "string" + TypedMoney: + type: "object" + discriminator: + propertyName: type + mapping: + centPrecision: '#/components/schemas/CentPrecisionMoney' + highPrecision: '#/components/schemas/HighPrecisionMoney' + properties: + type: + $ref: '#/components/schemas/MoneyType' + fractionDigits: + type: "integer" + format: "int32" + centAmount: + type: "integer" + format: "int64" + currencyCode: + $ref: '#/components/schemas/CurrencyCode' + TypedMoneyDraft: + allOf: + - $ref: '#/components/schemas/Money' + - type: "object" + discriminator: + propertyName: type + mapping: + centPrecision: '#/components/schemas/CentPrecisionMoneyDraft' + highPrecision: '#/components/schemas/HighPrecisionMoneyDraft' + properties: + centAmount: + type: "integer" + format: "int64" + currencyCode: + $ref: '#/components/schemas/CurrencyCode' + type: + $ref: '#/components/schemas/MoneyType' + fractionDigits: + type: "integer" + format: "int32" + CustomObject: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + container: + type: "string" + key: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CustomObjectDraft: + type: "object" + properties: + container: + type: "string" + key: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + version: + type: "integer" + format: "int64" + CustomObjectPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/CustomObject' + CustomObjectReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/CustomObject' + CustomerGroup: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + name: + type: "string" + custom: + $ref: '#/components/schemas/CustomFields' + CustomerGroupDraft: + type: "object" + properties: + key: + type: "string" + groupName: + type: "string" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + CustomerGroupPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/CustomerGroup' + CustomerGroupReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/CustomerGroup' + CustomerGroupResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + CustomerGroupUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/CustomerGroupUpdateAction' + CustomerGroupUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + changeName: '#/components/schemas/CustomerGroupChangeNameAction' + setCustomField: '#/components/schemas/CustomerGroupSetCustomFieldAction' + setCustomType: '#/components/schemas/CustomerGroupSetCustomTypeAction' + setKey: '#/components/schemas/CustomerGroupSetKeyAction' + properties: + action: + type: "string" + CustomerGroupChangeNameAction: + allOf: + - $ref: '#/components/schemas/CustomerGroupUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + CustomerGroupSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CustomerGroupUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CustomerGroupSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CustomerGroupUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + CustomerGroupSetKeyAction: + allOf: + - $ref: '#/components/schemas/CustomerGroupUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + AnonymousCartSignInMode: + type: "string" + enum: + - MergeWithExistingCustomerCart + - UseAsNewActiveCustomerCart + x-annotation-package: "Customer" + Customer: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + customerNumber: + type: "string" + email: + type: "string" + password: + type: "string" + firstName: + type: "string" + lastName: + type: "string" + middleName: + type: "string" + title: + type: "string" + dateOfBirth: + type: "string" + format: "date-only" + companyName: + type: "string" + vatId: + type: "string" + addresses: + type: "array" + items: + $ref: '#/components/schemas/Address' + defaultShippingAddressId: + type: "string" + shippingAddressIds: + type: "array" + items: + type: "string" + defaultBillingAddressId: + type: "string" + billingAddressIds: + type: "array" + items: + type: "string" + isEmailVerified: + type: "boolean" + externalId: + type: "string" + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + custom: + $ref: '#/components/schemas/CustomFields' + locale: + type: "string" + salutation: + type: "string" + key: + type: "string" + stores: + type: "array" + items: + $ref: '#/components/schemas/StoreKeyReference' + CustomerChangePassword: + type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + currentPassword: + type: "string" + newPassword: + type: "string" + CustomerCreateEmailToken: + type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + ttlMinutes: + type: "integer" + format: "int64" + CustomerCreatePasswordResetToken: + type: "object" + properties: + email: + type: "string" + ttlMinutes: + type: "integer" + format: "int64" + CustomerDraft: + type: "object" + properties: + customerNumber: + type: "string" + email: + type: "string" + password: + type: "string" + firstName: + type: "string" + lastName: + type: "string" + middleName: + type: "string" + title: + type: "string" + anonymousCartId: + type: "string" + anonymousCart: + $ref: '#/components/schemas/CartResourceIdentifier' + anonymousId: + type: "string" + dateOfBirth: + type: "string" + format: "date-only" + companyName: + type: "string" + vatId: + type: "string" + addresses: + type: "array" + items: + $ref: '#/components/schemas/BaseAddress' + defaultShippingAddress: + type: "integer" + format: "int32" + shippingAddresses: + type: "array" + items: + type: "integer" + format: "int32" + defaultBillingAddress: + type: "integer" + format: "int32" + billingAddresses: + type: "array" + items: + type: "integer" + format: "int32" + isEmailVerified: + type: "boolean" + externalId: + type: "string" + customerGroup: + $ref: '#/components/schemas/CustomerGroupResourceIdentifier' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + locale: + type: "string" + salutation: + type: "string" + key: + type: "string" + stores: + type: "array" + items: + $ref: '#/components/schemas/StoreResourceIdentifier' + CustomerEmailVerify: + type: "object" + properties: + version: + type: "integer" + format: "int64" + tokenValue: + type: "string" + CustomerPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Customer' + CustomerReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/Customer' + CustomerResetPassword: + type: "object" + properties: + tokenValue: + type: "string" + newPassword: + type: "string" + version: + type: "integer" + format: "int64" + CustomerResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + CustomerSignInResult: + type: "object" + properties: + customer: + $ref: '#/components/schemas/Customer' + cart: + $ref: '#/components/schemas/Cart' + CustomerSignin: + type: "object" + properties: + email: + type: "string" + password: + type: "string" + anonymousCartId: + type: "string" + anonymousCart: + $ref: '#/components/schemas/CartResourceIdentifier' + anonymousCartSignInMode: + $ref: '#/components/schemas/AnonymousCartSignInMode' + anonymousId: + type: "string" + updateProductData: + type: "boolean" + CustomerToken: + type: "object" + properties: + id: + type: "string" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + customerId: + type: "string" + expiresAt: + type: "string" + format: "datetime" + value: + type: "string" + CustomerUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/CustomerUpdateAction' + CustomerUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addAddress: '#/components/schemas/CustomerAddAddressAction' + addBillingAddressId: '#/components/schemas/CustomerAddBillingAddressIdAction' + addShippingAddressId: '#/components/schemas/CustomerAddShippingAddressIdAction' + addStore: '#/components/schemas/CustomerAddStoreAction' + changeAddress: '#/components/schemas/CustomerChangeAddressAction' + changeEmail: '#/components/schemas/CustomerChangeEmailAction' + removeAddress: '#/components/schemas/CustomerRemoveAddressAction' + removeBillingAddressId: '#/components/schemas/CustomerRemoveBillingAddressIdAction' + removeShippingAddressId: '#/components/schemas/CustomerRemoveShippingAddressIdAction' + removeStore: '#/components/schemas/CustomerRemoveStoreAction' + setAddressCustomField: '#/components/schemas/CustomerSetAddressCustomFieldAction' + setAddressCustomType: '#/components/schemas/CustomerSetAddressCustomTypeAction' + setCompanyName: '#/components/schemas/CustomerSetCompanyNameAction' + setCustomField: '#/components/schemas/CustomerSetCustomFieldAction' + setCustomType: '#/components/schemas/CustomerSetCustomTypeAction' + setCustomerGroup: '#/components/schemas/CustomerSetCustomerGroupAction' + setCustomerNumber: '#/components/schemas/CustomerSetCustomerNumberAction' + setDateOfBirth: '#/components/schemas/CustomerSetDateOfBirthAction' + setDefaultBillingAddress: '#/components/schemas/CustomerSetDefaultBillingAddressAction' + setDefaultShippingAddress: '#/components/schemas/CustomerSetDefaultShippingAddressAction' + setExternalId: '#/components/schemas/CustomerSetExternalIdAction' + setFirstName: '#/components/schemas/CustomerSetFirstNameAction' + setKey: '#/components/schemas/CustomerSetKeyAction' + setLastName: '#/components/schemas/CustomerSetLastNameAction' + setLocale: '#/components/schemas/CustomerSetLocaleAction' + setMiddleName: '#/components/schemas/CustomerSetMiddleNameAction' + setSalutation: '#/components/schemas/CustomerSetSalutationAction' + setStores: '#/components/schemas/CustomerSetStoresAction' + setTitle: '#/components/schemas/CustomerSetTitleAction' + setVatId: '#/components/schemas/CustomerSetVatIdAction' + properties: + action: + type: "string" + MyCustomerChangePassword: + type: "object" + properties: + version: + type: "integer" + format: "int64" + currentPassword: + type: "string" + newPassword: + type: "string" + CustomerAddAddressAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + CustomerAddBillingAddressIdAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + CustomerAddShippingAddressIdAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + CustomerAddStoreAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + store: + $ref: '#/components/schemas/StoreResourceIdentifier' + CustomerChangeAddressAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + CustomerChangeEmailAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + email: + type: "string" + CustomerRemoveAddressAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + CustomerRemoveBillingAddressIdAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + CustomerRemoveShippingAddressIdAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + CustomerRemoveStoreAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + store: + $ref: '#/components/schemas/StoreResourceIdentifier' + CustomerSetAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CustomerSetAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + addressId: + type: "string" + CustomerSetCompanyNameAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + companyName: + type: "string" + CustomerSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CustomerSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + CustomerSetCustomerGroupAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + customerGroup: + $ref: '#/components/schemas/CustomerGroupResourceIdentifier' + CustomerSetCustomerNumberAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + customerNumber: + type: "string" + CustomerSetDateOfBirthAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + dateOfBirth: + type: "string" + format: "date-only" + CustomerSetDefaultBillingAddressAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + CustomerSetDefaultShippingAddressAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + CustomerSetExternalIdAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + externalId: + type: "string" + CustomerSetFirstNameAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + firstName: + type: "string" + CustomerSetKeyAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + CustomerSetLastNameAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + lastName: + type: "string" + CustomerSetLocaleAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + locale: + type: "string" + CustomerSetMiddleNameAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + middleName: + type: "string" + CustomerSetSalutationAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + salutation: + type: "string" + CustomerSetStoresAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + stores: + type: "array" + items: + $ref: '#/components/schemas/StoreResourceIdentifier' + CustomerSetTitleAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + title: + type: "string" + CustomerSetVatIdAction: + allOf: + - $ref: '#/components/schemas/CustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + vatId: + type: "string" + DiscountCode: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + code: + type: "string" + cartDiscounts: + type: "array" + items: + $ref: '#/components/schemas/CartDiscountReference' + cartPredicate: + type: "string" + isActive: + type: "boolean" + references: + type: "array" + items: + $ref: '#/components/schemas/Reference' + maxApplications: + type: "integer" + format: "int64" + maxApplicationsPerCustomer: + type: "integer" + format: "int64" + custom: + $ref: '#/components/schemas/CustomFields' + groups: + type: "array" + items: + type: "string" + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + applicationVersion: + type: "integer" + format: "int64" + DiscountCodeDraft: + type: "object" + properties: + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + code: + type: "string" + cartDiscounts: + type: "array" + items: + $ref: '#/components/schemas/CartDiscountResourceIdentifier' + cartPredicate: + type: "string" + isActive: + type: "boolean" + maxApplications: + type: "integer" + format: "int64" + maxApplicationsPerCustomer: + type: "integer" + format: "int64" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + groups: + type: "array" + items: + type: "string" + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + DiscountCodePagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/DiscountCode' + DiscountCodeReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/DiscountCode' + DiscountCodeResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + DiscountCodeUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/DiscountCodeUpdateAction' + DiscountCodeUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + changeCartDiscounts: '#/components/schemas/DiscountCodeChangeCartDiscountsAction' + changeGroups: '#/components/schemas/DiscountCodeChangeGroupsAction' + changeIsActive: '#/components/schemas/DiscountCodeChangeIsActiveAction' + setCartPredicate: '#/components/schemas/DiscountCodeSetCartPredicateAction' + setCustomField: '#/components/schemas/DiscountCodeSetCustomFieldAction' + setCustomType: '#/components/schemas/DiscountCodeSetCustomTypeAction' + setDescription: '#/components/schemas/DiscountCodeSetDescriptionAction' + setMaxApplications: '#/components/schemas/DiscountCodeSetMaxApplicationsAction' + setMaxApplicationsPerCustomer: '#/components/schemas/DiscountCodeSetMaxApplicationsPerCustomerAction' + setName: '#/components/schemas/DiscountCodeSetNameAction' + setValidFrom: '#/components/schemas/DiscountCodeSetValidFromAction' + setValidFromAndUntil: '#/components/schemas/DiscountCodeSetValidFromAndUntilAction' + setValidUntil: '#/components/schemas/DiscountCodeSetValidUntilAction' + properties: + action: + type: "string" + DiscountCodeChangeCartDiscountsAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + cartDiscounts: + type: "array" + items: + $ref: '#/components/schemas/CartDiscountResourceIdentifier' + DiscountCodeChangeGroupsAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + groups: + type: "array" + items: + type: "string" + DiscountCodeChangeIsActiveAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + isActive: + type: "boolean" + DiscountCodeSetCartPredicateAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + cartPredicate: + type: "string" + DiscountCodeSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + DiscountCodeSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + DiscountCodeSetDescriptionAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + DiscountCodeSetMaxApplicationsAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + maxApplications: + type: "integer" + format: "int64" + DiscountCodeSetMaxApplicationsPerCustomerAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + maxApplicationsPerCustomer: + type: "integer" + format: "int64" + DiscountCodeSetNameAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + DiscountCodeSetValidFromAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + validFrom: + type: "string" + format: "datetime" + DiscountCodeSetValidFromAndUntilAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + DiscountCodeSetValidUntilAction: + allOf: + - $ref: '#/components/schemas/DiscountCodeUpdateAction' + - type: "object" + properties: + action: + type: "string" + validUntil: + type: "string" + format: "datetime" + AccessDeniedError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + AnonymousIdAlreadyInUseError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + AttributeDefinitionAlreadyExistsError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + conflictingProductTypeId: + type: "string" + conflictingProductTypeName: + type: "string" + conflictingAttributeName: + type: "string" + AttributeDefinitionTypeConflictError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + conflictingProductTypeId: + type: "string" + conflictingProductTypeName: + type: "string" + conflictingAttributeName: + type: "string" + AttributeNameDoesNotExistError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + invalidAttributeName: + type: "string" + BadGatewayError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + ConcurrentModificationError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + currentVersion: + type: "integer" + format: "int64" + DiscountCodeNonApplicableError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + discountCode: + type: "string" + reason: + type: "string" + dicountCodeId: + type: "string" + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + validityCheckTime: + type: "string" + format: "datetime" + DuplicateAttributeValueError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + attribute: + $ref: '#/components/schemas/Attribute' + DuplicateAttributeValuesError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + attributes: + type: "array" + items: + $ref: '#/components/schemas/Attribute' + DuplicateEnumValuesError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + duplicates: + type: "array" + items: + type: "string" + DuplicateFieldError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + field: + type: "string" + duplicateValue: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + conflictingResource: + $ref: '#/components/schemas/Reference' + DuplicateFieldWithConflictingResourceError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + field: + type: "string" + duplicateValue: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + conflictingResource: + $ref: '#/components/schemas/Reference' + DuplicatePriceScopeError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + conflictingPrices: + type: "array" + items: + $ref: '#/components/schemas/Price' + DuplicateVariantValuesError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + variantValues: + $ref: '#/components/schemas/VariantValues' + EditPreviewFailedError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + result: + $ref: '#/components/schemas/OrderEditPreviewFailure' + EnumKeyAlreadyExistsError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + conflictingEnumKey: + type: "string" + conflictingAttributeName: + type: "string" + EnumKeyDoesNotExistError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + conflictingEnumKey: + type: "string" + conflictingAttributeName: + type: "string" + EnumValueIsUsedError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + EnumValuesMustMatchError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + ErrorByExtension: + type: "object" + properties: + id: + type: "string" + key: + type: "string" + ErrorObject: + type: "object" + discriminator: + propertyName: code + mapping: + access_denied: '#/components/schemas/AccessDeniedError' + AnonymousIdAlreadyInUse: '#/components/schemas/AnonymousIdAlreadyInUseError' + AttributeDefinitionAlreadyExists: '#/components/schemas/AttributeDefinitionAlreadyExistsError' + AttributeDefinitionTypeConflict: '#/components/schemas/AttributeDefinitionTypeConflictError' + AttributeNameDoesNotExist: '#/components/schemas/AttributeNameDoesNotExistError' + BadGateway: '#/components/schemas/BadGatewayError' + ConcurrentModification: '#/components/schemas/ConcurrentModificationError' + DiscountCodeNonApplicable: '#/components/schemas/DiscountCodeNonApplicableError' + DuplicateAttributeValue: '#/components/schemas/DuplicateAttributeValueError' + DuplicateAttributeValues: '#/components/schemas/DuplicateAttributeValuesError' + DuplicateEnumValues: '#/components/schemas/DuplicateEnumValuesError' + DuplicateField: '#/components/schemas/DuplicateFieldError' + DuplicateFieldWithConflictingResource: '#/components/schemas/DuplicateFieldWithConflictingResourceError' + DuplicatePriceScope: '#/components/schemas/DuplicatePriceScopeError' + DuplicateVariantValues: '#/components/schemas/DuplicateVariantValuesError' + EditPreviewFailed: '#/components/schemas/EditPreviewFailedError' + EnumKeyAlreadyExists: '#/components/schemas/EnumKeyAlreadyExistsError' + EnumKeyDoesNotExist: '#/components/schemas/EnumKeyDoesNotExistError' + EnumValueIsUsed: '#/components/schemas/EnumValueIsUsedError' + EnumValuesMustMatch: '#/components/schemas/EnumValuesMustMatchError' + ExtensionBadResponse: '#/components/schemas/ExtensionBadResponseError' + ExtensionNoResponse: '#/components/schemas/ExtensionNoResponseError' + ExtensionUpdateActionsFailed: '#/components/schemas/ExtensionUpdateActionsFailedError' + ExternalOAuthFailed: '#/components/schemas/ExternalOAuthFailedError' + FeatureRemoved: '#/components/schemas/FeatureRemovedError' + General: '#/components/schemas/GeneralError' + insufficient_scope: '#/components/schemas/InsufficientScopeError' + InternalConstraintViolated: '#/components/schemas/InternalConstraintViolatedError' + InvalidCredentials: '#/components/schemas/InvalidCredentialsError' + InvalidCurrentPassword: '#/components/schemas/InvalidCurrentPasswordError' + InvalidField: '#/components/schemas/InvalidFieldError' + InvalidInput: '#/components/schemas/InvalidInputError' + InvalidItemShippingDetails: '#/components/schemas/InvalidItemShippingDetailsError' + InvalidJsonInput: '#/components/schemas/InvalidJsonInputError' + InvalidOperation: '#/components/schemas/InvalidOperationError' + InvalidSubject: '#/components/schemas/InvalidSubjectError' + invalid_token: '#/components/schemas/InvalidTokenError' + LanguageUsedInStores: '#/components/schemas/LanguageUsedInStoresError' + MatchingPriceNotFound: '#/components/schemas/MatchingPriceNotFoundError' + MaxResourceLimitExceeded: '#/components/schemas/MaxResourceLimitExceededError' + MissingRoleOnChannel: '#/components/schemas/MissingRoleOnChannelError' + MissingTaxRateForCountry: '#/components/schemas/MissingTaxRateForCountryError' + NoMatchingProductDiscountFound: '#/components/schemas/NoMatchingProductDiscountFoundError' + NotEnabled: '#/components/schemas/NotEnabledError' + ObjectNotFound: '#/components/schemas/ObjectNotFoundError' + OutOfStock: '#/components/schemas/OutOfStockError' + OverCapacity: '#/components/schemas/OverCapacityError' + PendingOperation: '#/components/schemas/PendingOperationError' + PriceChanged: '#/components/schemas/PriceChangedError' + ProjectNotConfiguredForLanguages: '#/components/schemas/ProjectNotConfiguredForLanguagesError' + QueryComplexityLimitExceeded: '#/components/schemas/QueryComplexityLimitExceededError' + QueryTimedOut: '#/components/schemas/QueryTimedOutError' + ReferenceExists: '#/components/schemas/ReferenceExistsError' + ReferencedResourceNotFound: '#/components/schemas/ReferencedResourceNotFoundError' + RequiredField: '#/components/schemas/RequiredFieldError' + ResourceNotFound: '#/components/schemas/ResourceNotFoundError' + ResourceSizeLimitExceeded: '#/components/schemas/ResourceSizeLimitExceededError' + SearchDeactivated: '#/components/schemas/SearchDeactivatedError' + SearchExecutionFailure: '#/components/schemas/SearchExecutionFailureError' + SearchFacetPathNotFound: '#/components/schemas/SearchFacetPathNotFoundError' + SearchIndexingInProgress: '#/components/schemas/SearchIndexingInProgressError' + SemanticError: '#/components/schemas/SemanticErrorError' + ShippingMethodDoesNotMatchCart: '#/components/schemas/ShippingMethodDoesNotMatchCartError' + SyntaxError: '#/components/schemas/SyntaxErrorError' + WeakPassword: '#/components/schemas/WeakPasswordError' + properties: + code: + type: "string" + message: + type: "string" + ErrorResponse: + type: "object" + properties: + statusCode: + type: "integer" + format: "int32" + message: + type: "string" + error: + type: "string" + error_description: + type: "string" + errors: + type: "array" + items: + $ref: '#/components/schemas/ErrorObject' + ExtensionBadResponseError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + localizedMessage: + $ref: '#/components/schemas/LocalizedString' + extensionExtraInfo: + type: "string" + additionalProperties: true + errorByExtension: + $ref: '#/components/schemas/ErrorByExtension' + ExtensionNoResponseError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + extensionId: + type: "string" + extensionKey: + type: "string" + ExtensionUpdateActionsFailedError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + localizedMessage: + $ref: '#/components/schemas/LocalizedString' + extensionExtraInfo: + type: "string" + additionalProperties: true + errorByExtension: + $ref: '#/components/schemas/ErrorByExtension' + ExternalOAuthFailedError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + FeatureRemovedError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + GeneralError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + InsufficientScopeError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + InternalConstraintViolatedError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + InvalidCredentialsError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + InvalidCurrentPasswordError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + InvalidFieldError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + field: + type: "string" + invalidValue: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + allowedValues: + type: "array" + items: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + InvalidInputError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + InvalidItemShippingDetailsError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + subject: + type: "string" + itemId: + type: "string" + InvalidJsonInputError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + InvalidOperationError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + InvalidSubjectError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + InvalidTokenError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + LanguageUsedInStoresError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + MatchingPriceNotFoundError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + productId: + type: "string" + variantId: + type: "integer" + format: "int32" + currency: + type: "string" + country: + type: "string" + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + channel: + $ref: '#/components/schemas/ChannelReference' + MaxResourceLimitExceededError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + exceededResource: + $ref: '#/components/schemas/ReferenceTypeId' + MissingRoleOnChannelError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + channel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + missingRole: + $ref: '#/components/schemas/ChannelRoleEnum' + MissingTaxRateForCountryError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + taxCategoryId: + type: "string" + country: + type: "string" + state: + type: "string" + NoMatchingProductDiscountFoundError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + NotEnabledError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + ObjectNotFoundError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + OutOfStockError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + lineItems: + type: "array" + items: + type: "string" + skus: + type: "array" + items: + type: "string" + OverCapacityError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + PendingOperationError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + PriceChangedError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + lineItems: + type: "array" + items: + type: "string" + shipping: + type: "boolean" + ProjectNotConfiguredForLanguagesError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + languages: + type: "array" + items: + type: "string" + QueryComplexityLimitExceededError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + QueryTimedOutError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + ReferenceExistsError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + referencedBy: + $ref: '#/components/schemas/ReferenceTypeId' + ReferencedResourceNotFoundError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + RequiredFieldError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + field: + type: "string" + ResourceNotFoundError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + ResourceSizeLimitExceededError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + SearchDeactivatedError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + SearchExecutionFailureError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + SearchFacetPathNotFoundError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + SearchIndexingInProgressError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + SemanticErrorError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + ShippingMethodDoesNotMatchCartError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + SyntaxErrorError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + VariantValues: + type: "object" + properties: + sku: + type: "string" + prices: + type: "array" + items: + $ref: '#/components/schemas/PriceDraft' + attributes: + type: "array" + items: + $ref: '#/components/schemas/Attribute' + WeakPasswordError: + allOf: + - $ref: '#/components/schemas/ErrorObject' + - type: "object" + properties: + code: + type: "string" + message: + type: "string" + Extension: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + destination: + $ref: '#/components/schemas/ExtensionDestination' + triggers: + type: "array" + items: + $ref: '#/components/schemas/ExtensionTrigger' + timeoutInMs: + type: "integer" + format: "int32" + ExtensionAWSLambdaDestination: + allOf: + - $ref: '#/components/schemas/ExtensionDestination' + - type: "object" + properties: + type: + type: "string" + arn: + type: "string" + accessKey: + type: "string" + accessSecret: + type: "string" + ExtensionAction: + type: "string" + enum: + - Create + - Update + x-annotation-package: "Extension" + ExtensionAuthorizationHeaderAuthentication: + allOf: + - $ref: '#/components/schemas/ExtensionHttpDestinationAuthentication' + - type: "object" + properties: + type: + type: "string" + headerValue: + type: "string" + ExtensionAzureFunctionsAuthentication: + allOf: + - $ref: '#/components/schemas/ExtensionHttpDestinationAuthentication' + - type: "object" + properties: + type: + type: "string" + key: + type: "string" + ExtensionDestination: + type: "object" + discriminator: + propertyName: type + mapping: + AWSLambda: '#/components/schemas/ExtensionAWSLambdaDestination' + HTTP: '#/components/schemas/ExtensionHttpDestination' + properties: + type: + type: "string" + ExtensionDraft: + type: "object" + properties: + key: + type: "string" + destination: + $ref: '#/components/schemas/ExtensionDestination' + triggers: + type: "array" + items: + $ref: '#/components/schemas/ExtensionTrigger' + timeoutInMs: + type: "integer" + format: "int32" + ExtensionHttpDestination: + allOf: + - $ref: '#/components/schemas/ExtensionDestination' + - type: "object" + properties: + type: + type: "string" + url: + type: "string" + authentication: + $ref: '#/components/schemas/ExtensionHttpDestinationAuthentication' + ExtensionHttpDestinationAuthentication: + type: "object" + discriminator: + propertyName: type + mapping: + AuthorizationHeader: '#/components/schemas/ExtensionAuthorizationHeaderAuthentication' + AzureFunctions: '#/components/schemas/ExtensionAzureFunctionsAuthentication' + properties: + type: + type: "string" + ExtensionInput: + type: "object" + properties: + action: + $ref: '#/components/schemas/ExtensionAction' + resource: + $ref: '#/components/schemas/Reference' + ExtensionPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Extension' + ExtensionResourceTypeId: + type: "string" + enum: + - cart + - order + - payment + - customer + x-annotation-package: "Extension" + ExtensionTrigger: + type: "object" + properties: + resourceTypeId: + $ref: '#/components/schemas/ExtensionResourceTypeId' + actions: + type: "array" + items: + $ref: '#/components/schemas/ExtensionAction' + ExtensionUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/ExtensionUpdateAction' + ExtensionUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + changeDestination: '#/components/schemas/ExtensionChangeDestinationAction' + changeTriggers: '#/components/schemas/ExtensionChangeTriggersAction' + setKey: '#/components/schemas/ExtensionSetKeyAction' + setTimeoutInMs: '#/components/schemas/ExtensionSetTimeoutInMsAction' + properties: + action: + type: "string" + ExtensionChangeDestinationAction: + allOf: + - $ref: '#/components/schemas/ExtensionUpdateAction' + - type: "object" + properties: + action: + type: "string" + destination: + $ref: '#/components/schemas/ExtensionDestination' + ExtensionChangeTriggersAction: + allOf: + - $ref: '#/components/schemas/ExtensionUpdateAction' + - type: "object" + properties: + action: + type: "string" + triggers: + type: "array" + items: + $ref: '#/components/schemas/ExtensionTrigger' + ExtensionSetKeyAction: + allOf: + - $ref: '#/components/schemas/ExtensionUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + ExtensionSetTimeoutInMsAction: + allOf: + - $ref: '#/components/schemas/ExtensionUpdateAction' + - type: "object" + properties: + action: + type: "string" + timeoutInMs: + type: "integer" + format: "int32" + GraphQLError: + type: "object" + properties: + message: + type: "string" + locations: + type: "array" + items: + $ref: '#/components/schemas/GraphQLErrorLocation' + path: + type: "array" + items: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + GraphQLErrorLocation: + type: "object" + properties: + line: + type: "integer" + format: "int32" + column: + type: "integer" + format: "int32" + GraphQLRequest: + type: "object" + properties: + query: + type: "string" + operationName: + type: "string" + variables: + $ref: '#/components/schemas/GraphQLVariablesMap' + GraphQLResponse: + type: "object" + properties: + data: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + errors: + type: "array" + items: + $ref: '#/components/schemas/GraphQLError' + GraphQLVariablesMap: + type: "object" + additionalProperties: + type: "string" + InventoryEntry: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sku: + type: "string" + supplyChannel: + $ref: '#/components/schemas/ChannelReference' + quantityOnStock: + type: "integer" + format: "int64" + availableQuantity: + type: "integer" + format: "int64" + restockableInDays: + type: "integer" + format: "int64" + expectedDelivery: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFields' + InventoryEntryDraft: + type: "object" + properties: + sku: + type: "string" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + quantityOnStock: + type: "integer" + format: "int64" + restockableInDays: + type: "integer" + format: "int64" + expectedDelivery: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + InventoryEntryReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/InventoryEntry' + InventoryEntryResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + InventoryEntryUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/InventoryEntryUpdateAction' + InventoryEntryUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addQuantity: '#/components/schemas/InventoryEntryAddQuantityAction' + changeQuantity: '#/components/schemas/InventoryEntryChangeQuantityAction' + removeQuantity: '#/components/schemas/InventoryEntryRemoveQuantityAction' + setCustomField: '#/components/schemas/InventoryEntrySetCustomFieldAction' + setCustomType: '#/components/schemas/InventoryEntrySetCustomTypeAction' + setExpectedDelivery: '#/components/schemas/InventoryEntrySetExpectedDeliveryAction' + setRestockableInDays: '#/components/schemas/InventoryEntrySetRestockableInDaysAction' + setSupplyChannel: '#/components/schemas/InventoryEntrySetSupplyChannelAction' + properties: + action: + type: "string" + InventoryPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/InventoryEntry' + InventoryEntryAddQuantityAction: + allOf: + - $ref: '#/components/schemas/InventoryEntryUpdateAction' + - type: "object" + properties: + action: + type: "string" + quantity: + type: "integer" + format: "int64" + InventoryEntryChangeQuantityAction: + allOf: + - $ref: '#/components/schemas/InventoryEntryUpdateAction' + - type: "object" + properties: + action: + type: "string" + quantity: + type: "integer" + format: "int64" + InventoryEntryRemoveQuantityAction: + allOf: + - $ref: '#/components/schemas/InventoryEntryUpdateAction' + - type: "object" + properties: + action: + type: "string" + quantity: + type: "integer" + format: "int64" + InventoryEntrySetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/InventoryEntryUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + InventoryEntrySetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/InventoryEntryUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + InventoryEntrySetExpectedDeliveryAction: + allOf: + - $ref: '#/components/schemas/InventoryEntryUpdateAction' + - type: "object" + properties: + action: + type: "string" + expectedDelivery: + type: "string" + format: "datetime" + InventoryEntrySetRestockableInDaysAction: + allOf: + - $ref: '#/components/schemas/InventoryEntryUpdateAction' + - type: "object" + properties: + action: + type: "string" + restockableInDays: + type: "integer" + format: "int64" + InventoryEntrySetSupplyChannelAction: + allOf: + - $ref: '#/components/schemas/InventoryEntryUpdateAction' + - type: "object" + properties: + action: + type: "string" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + MyCartDraft: + type: "object" + properties: + currency: + $ref: '#/components/schemas/CurrencyCode' + customerEmail: + type: "string" + country: + type: "string" + inventoryMode: + $ref: '#/components/schemas/InventoryMode' + lineItems: + type: "array" + items: + $ref: '#/components/schemas/MyLineItemDraft' + shippingAddress: + $ref: '#/components/schemas/BaseAddress' + billingAddress: + $ref: '#/components/schemas/BaseAddress' + shippingMethod: + $ref: '#/components/schemas/ShippingMethodResourceIdentifier' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + locale: + type: "string" + taxMode: + $ref: '#/components/schemas/TaxMode' + deleteDaysAfterLastModification: + type: "integer" + format: "int64" + itemShippingAddresses: + type: "array" + items: + $ref: '#/components/schemas/BaseAddress' + store: + $ref: '#/components/schemas/StoreKeyReference' + discountCodes: + type: "array" + items: + $ref: '#/components/schemas/DiscountCodeInfo' + MyCartUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/MyCartUpdateAction' + MyCartUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addDiscountCode: '#/components/schemas/MyCartAddDiscountCodeAction' + addItemShippingAddress: '#/components/schemas/MyCartAddItemShippingAddressAction' + addLineItem: '#/components/schemas/MyCartAddLineItemAction' + addPayment: '#/components/schemas/MyCartAddPaymentAction' + applyDeltaToLineItemShippingDetailsTargets: '#/components/schemas/MyCartApplyDeltaToLineItemShippingDetailsTargetsAction' + changeLineItemQuantity: '#/components/schemas/MyCartChangeLineItemQuantityAction' + changeTaxMode: '#/components/schemas/MyCartChangeTaxModeAction' + recalculate: '#/components/schemas/MyCartRecalculateAction' + removeDiscountCode: '#/components/schemas/MyCartRemoveDiscountCodeAction' + removeItemShippingAddress: '#/components/schemas/MyCartRemoveItemShippingAddressAction' + removeLineItem: '#/components/schemas/MyCartRemoveLineItemAction' + removePayment: '#/components/schemas/MyCartRemovePaymentAction' + setBillingAddress: '#/components/schemas/MyCartSetBillingAddressAction' + setCountry: '#/components/schemas/MyCartSetCountryAction' + setCustomField: '#/components/schemas/MyCartSetCustomFieldAction' + setCustomType: '#/components/schemas/MyCartSetCustomTypeAction' + setCustomerEmail: '#/components/schemas/MyCartSetCustomerEmailAction' + setDeleteDaysAfterLastModification: '#/components/schemas/MyCartSetDeleteDaysAfterLastModificationAction' + setLineItemCustomField: '#/components/schemas/MyCartSetLineItemCustomFieldAction' + setLineItemCustomType: '#/components/schemas/MyCartSetLineItemCustomTypeAction' + setLineItemDistributionChannel: '#/components/schemas/MyCartSetLineItemDistributionChannelAction' + setLineItemShippingDetails: '#/components/schemas/MyCartSetLineItemShippingDetailsAction' + setLineItemSupplyChannel: '#/components/schemas/MyCartSetLineItemSupplyChannelAction' + setLocale: '#/components/schemas/MyCartSetLocaleAction' + setShippingAddress: '#/components/schemas/MyCartSetShippingAddressAction' + setShippingMethod: '#/components/schemas/MyCartSetShippingMethodAction' + updateItemShippingAddress: '#/components/schemas/MyCartUpdateItemShippingAddressAction' + properties: + action: + type: "string" + MyCustomerDraft: + type: "object" + properties: + email: + type: "string" + password: + type: "string" + firstName: + type: "string" + lastName: + type: "string" + middleName: + type: "string" + title: + type: "string" + dateOfBirth: + type: "string" + format: "date-only" + companyName: + type: "string" + vatId: + type: "string" + addresses: + type: "array" + items: + $ref: '#/components/schemas/BaseAddress' + defaultShippingAddress: + type: "integer" + format: "int64" + defaultBillingAddress: + type: "integer" + format: "int64" + custom: + $ref: '#/components/schemas/CustomFields' + locale: + type: "string" + stores: + type: "array" + items: + $ref: '#/components/schemas/StoreResourceIdentifier' + MyCustomerUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/MyCustomerUpdateAction' + MyCustomerUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addAddress: '#/components/schemas/MyCustomerAddAddressAction' + addBillingAddressId: '#/components/schemas/MyCustomerAddBillingAddressIdAction' + addShippingAddressId: '#/components/schemas/MyCustomerAddShippingAddressIdAction' + changeAddress: '#/components/schemas/MyCustomerChangeAddressAction' + changeEmail: '#/components/schemas/MyCustomerChangeEmailAction' + removeAddress: '#/components/schemas/MyCustomerRemoveAddressAction' + removeBillingAddressId: '#/components/schemas/MyCustomerRemoveBillingAddressIdAction' + removeShippingAddressId: '#/components/schemas/MyCustomerRemoveShippingAddressIdAction' + setCompanyName: '#/components/schemas/MyCustomerSetCompanyNameAction' + setCustomField: '#/components/schemas/MyCustomerSetCustomFieldAction' + setCustomType: '#/components/schemas/MyCustomerSetCustomTypeAction' + setDateOfBirth: '#/components/schemas/MyCustomerSetDateOfBirthAction' + setDefaultBillingAddress: '#/components/schemas/MyCustomerSetDefaultBillingAddressAction' + setDefaultShippingAddress: '#/components/schemas/MyCustomerSetDefaultShippingAddressAction' + setFirstName: '#/components/schemas/MyCustomerSetFirstNameAction' + setLastName: '#/components/schemas/MyCustomerSetLastNameAction' + setLocale: '#/components/schemas/MyCustomerSetLocaleAction' + setMiddleName: '#/components/schemas/MyCustomerSetMiddleNameAction' + setSalutation: '#/components/schemas/MyCustomerSetSalutationAction' + setTitle: '#/components/schemas/MyCustomerSetTitleAction' + setVatId: '#/components/schemas/MyCustomerSetVatIdAction' + properties: + action: + type: "string" + MyLineItemDraft: + type: "object" + properties: + productId: + type: "string" + variantId: + type: "integer" + format: "int64" + quantity: + type: "integer" + format: "int64" + addedAt: + type: "string" + format: "datetime" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + sku: + type: "string" + MyOrderFromCartDraft: + type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + MyPayment: + type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + customer: + $ref: '#/components/schemas/CustomerReference' + anonymousId: + type: "string" + amountPlanned: + $ref: '#/components/schemas/TypedMoney' + paymentMethodInfo: + $ref: '#/components/schemas/PaymentMethodInfo' + transactions: + type: "array" + items: + $ref: '#/components/schemas/Transaction' + custom: + $ref: '#/components/schemas/CustomFields' + MyPaymentDraft: + type: "object" + properties: + amountPlanned: + $ref: '#/components/schemas/Money' + paymentMethodInfo: + $ref: '#/components/schemas/PaymentMethodInfo' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + transaction: + $ref: '#/components/schemas/MyTransactionDraft' + MyPaymentPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/MyPayment' + MyPaymentUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/MyPaymentUpdateAction' + MyPaymentUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addTransaction: '#/components/schemas/MyPaymentAddTransactionAction' + changeAmountPlanned: '#/components/schemas/MyPaymentChangeAmountPlannedAction' + setCustomField: '#/components/schemas/MyPaymentSetCustomFieldAction' + setMethodInfoInterface: '#/components/schemas/MyPaymentSetMethodInfoInterfaceAction' + setMethodInfoMethod: '#/components/schemas/MyPaymentSetMethodInfoMethodAction' + setMethodInfoName: '#/components/schemas/MyPaymentSetMethodInfoNameAction' + setTransactionCustomField: '#/components/schemas/MyPaymentSetTransactionCustomFieldAction' + properties: + action: + type: "string" + MyShoppingListDraft: + type: "object" + properties: + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + lineItems: + type: "array" + items: + $ref: '#/components/schemas/ShoppingListLineItemDraft' + textLineItems: + type: "array" + items: + $ref: '#/components/schemas/TextLineItemDraft' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + deleteDaysAfterLastModification: + type: "integer" + format: "int64" + store: + $ref: '#/components/schemas/StoreResourceIdentifier' + MyShoppingListUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/MyShoppingListUpdateAction' + MyShoppingListUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addLineItem: '#/components/schemas/MyShoppingListAddLineItemAction' + addTextLineItem: '#/components/schemas/MyShoppingListAddTextLineItemAction' + changeLineItemQuantity: '#/components/schemas/MyShoppingListChangeLineItemQuantityAction' + changeLineItemsOrder: '#/components/schemas/MyShoppingListChangeLineItemsOrderAction' + changeName: '#/components/schemas/MyShoppingListChangeNameAction' + changeTextLineItemName: '#/components/schemas/MyShoppingListChangeTextLineItemNameAction' + changeTextLineItemQuantity: '#/components/schemas/MyShoppingListChangeTextLineItemQuantityAction' + changeTextLineItemsOrder: '#/components/schemas/MyShoppingListChangeTextLineItemsOrderAction' + removeLineItem: '#/components/schemas/MyShoppingListRemoveLineItemAction' + removeTextLineItem: '#/components/schemas/MyShoppingListRemoveTextLineItemAction' + setCustomField: '#/components/schemas/MyShoppingListSetCustomFieldAction' + setCustomType: '#/components/schemas/MyShoppingListSetCustomTypeAction' + setDeleteDaysAfterLastModification: '#/components/schemas/MyShoppingListSetDeleteDaysAfterLastModificationAction' + setDescription: '#/components/schemas/MyShoppingListSetDescriptionAction' + setLineItemCustomField: '#/components/schemas/MyShoppingListSetLineItemCustomFieldAction' + setLineItemCustomType: '#/components/schemas/MyShoppingListSetLineItemCustomTypeAction' + setTextLineItemCustomField: '#/components/schemas/MyShoppingListSetTextLineItemCustomFieldAction' + setTextLineItemCustomType: '#/components/schemas/MyShoppingListSetTextLineItemCustomTypeAction' + setTextLineItemDescription: '#/components/schemas/MyShoppingListSetTextLineItemDescriptionAction' + properties: + action: + type: "string" + MyTransactionDraft: + type: "object" + properties: + timestamp: + type: "string" + format: "datetime" + type: + $ref: '#/components/schemas/TransactionType' + amount: + $ref: '#/components/schemas/Money' + interactionId: + type: "string" + custom: + $ref: '#/components/schemas/CustomFields' + MyCartAddDiscountCodeAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + code: + type: "string" + MyCartAddItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + MyCartAddLineItemAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + productId: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + quantity: + type: "integer" + format: "int64" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + externalPrice: + $ref: '#/components/schemas/Money' + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + addedAt: + type: "string" + format: "datetime" + MyCartAddPaymentAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + payment: + $ref: '#/components/schemas/PaymentResourceIdentifier' + MyCartApplyDeltaToLineItemShippingDetailsTargetsAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + targetsDelta: + type: "array" + items: + $ref: '#/components/schemas/ItemShippingTarget' + MyCartChangeLineItemQuantityAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + externalPrice: + $ref: '#/components/schemas/Money' + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + MyCartChangeTaxModeAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxMode: + $ref: '#/components/schemas/TaxMode' + MyCartRecalculateAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + updateProductData: + type: "boolean" + MyCartRemoveDiscountCodeAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + discountCode: + $ref: '#/components/schemas/DiscountCodeReference' + MyCartRemoveItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressKey: + type: "string" + MyCartRemoveLineItemAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + externalPrice: + $ref: '#/components/schemas/Money' + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + shippingDetailsToRemove: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + MyCartRemovePaymentAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + payment: + $ref: '#/components/schemas/PaymentResourceIdentifier' + MyCartSetBillingAddressAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + MyCartSetCountryAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + country: + $ref: '#/components/schemas/CountryCode' + MyCartSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + MyCartSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + MyCartSetCustomerEmailAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + email: + type: "string" + MyCartSetDeleteDaysAfterLastModificationAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + deleteDaysAfterLastModification: + type: "integer" + format: "int32" + MyCartSetLineItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + MyCartSetLineItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + MyCartSetLineItemDistributionChannelAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + MyCartSetLineItemShippingDetailsAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + MyCartSetLineItemSupplyChannelAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + MyCartSetLocaleAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + locale: + type: "string" + MyCartSetShippingAddressAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + MyCartSetShippingMethodAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + shippingMethod: + $ref: '#/components/schemas/ShippingMethodResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + MyCartUpdateItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/MyCartUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + MyCustomerAddAddressAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + MyCustomerAddBillingAddressIdAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + MyCustomerAddShippingAddressIdAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + MyCustomerChangeAddressAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + MyCustomerChangeEmailAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + email: + type: "string" + MyCustomerRemoveAddressAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + MyCustomerRemoveBillingAddressIdAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + MyCustomerRemoveShippingAddressIdAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + MyCustomerSetCompanyNameAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + companyName: + type: "string" + MyCustomerSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + MyCustomerSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + MyCustomerSetDateOfBirthAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + dateOfBirth: + type: "string" + format: "date-only" + MyCustomerSetDefaultBillingAddressAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + MyCustomerSetDefaultShippingAddressAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressId: + type: "string" + addressKey: + type: "string" + MyCustomerSetFirstNameAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + firstName: + type: "string" + MyCustomerSetLastNameAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + lastName: + type: "string" + MyCustomerSetLocaleAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + locale: + type: "string" + MyCustomerSetMiddleNameAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + middleName: + type: "string" + MyCustomerSetSalutationAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + salutation: + type: "string" + MyCustomerSetTitleAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + title: + type: "string" + MyCustomerSetVatIdAction: + allOf: + - $ref: '#/components/schemas/MyCustomerUpdateAction' + - type: "object" + properties: + action: + type: "string" + vatId: + type: "string" + MyPaymentAddTransactionAction: + allOf: + - $ref: '#/components/schemas/MyPaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + transaction: + $ref: '#/components/schemas/TransactionDraft' + MyPaymentChangeAmountPlannedAction: + allOf: + - $ref: '#/components/schemas/MyPaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + amount: + $ref: '#/components/schemas/Money' + MyPaymentSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/MyPaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + MyPaymentSetMethodInfoInterfaceAction: + allOf: + - $ref: '#/components/schemas/MyPaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + interface: + type: "string" + MyPaymentSetMethodInfoMethodAction: + allOf: + - $ref: '#/components/schemas/MyPaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + method: + type: "string" + MyPaymentSetMethodInfoNameAction: + allOf: + - $ref: '#/components/schemas/MyPaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + MyPaymentSetTransactionCustomFieldAction: + allOf: + - $ref: '#/components/schemas/MyPaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + MyShoppingListAddLineItemAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + sku: + type: "string" + productId: + type: "string" + variantId: + type: "integer" + format: "int64" + quantity: + type: "integer" + format: "int64" + addedAt: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + MyShoppingListAddTextLineItemAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + quantity: + type: "integer" + format: "int64" + addedAt: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + MyShoppingListChangeLineItemQuantityAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + MyShoppingListChangeLineItemsOrderAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemOrder: + type: "array" + items: + type: "string" + MyShoppingListChangeNameAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + MyShoppingListChangeTextLineItemNameAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + MyShoppingListChangeTextLineItemQuantityAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + MyShoppingListChangeTextLineItemsOrderAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemOrder: + type: "array" + items: + type: "string" + MyShoppingListRemoveLineItemAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + MyShoppingListRemoveTextLineItemAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + MyShoppingListSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + MyShoppingListSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + MyShoppingListSetDeleteDaysAfterLastModificationAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + deleteDaysAfterLastModification: + type: "integer" + format: "int64" + MyShoppingListSetDescriptionAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + MyShoppingListSetLineItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + MyShoppingListSetLineItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + MyShoppingListSetTextLineItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + MyShoppingListSetTextLineItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + MyShoppingListSetTextLineItemDescriptionAction: + allOf: + - $ref: '#/components/schemas/MyShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + CategoryCreatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + category: + $ref: '#/components/schemas/Category' + CategorySlugChangedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + slug: + $ref: '#/components/schemas/LocalizedString' + oldSlug: + $ref: '#/components/schemas/LocalizedString' + ContainerAndKey: + type: "object" + properties: + key: + type: "string" + container: + type: "string" + CustomLineItemStateTransitionMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + customLineItemId: + type: "string" + transitionDate: + type: "string" + format: "datetime" + quantity: + type: "integer" + format: "int64" + fromState: + $ref: '#/components/schemas/StateReference' + toState: + $ref: '#/components/schemas/StateReference' + CustomerAddressAddedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + address: + $ref: '#/components/schemas/Address' + CustomerAddressChangedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + address: + $ref: '#/components/schemas/Address' + CustomerAddressRemovedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + address: + $ref: '#/components/schemas/Address' + CustomerCompanyNameSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + companyName: + type: "string" + CustomerCreatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + customer: + $ref: '#/components/schemas/Customer' + CustomerDateOfBirthSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + dateOfBirth: + type: "string" + format: "date-only" + CustomerDeletedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + CustomerEmailChangedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + email: + type: "string" + CustomerEmailVerifiedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + CustomerFirstNameSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + firstName: + type: "string" + CustomerGroupSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + CustomerLastNameSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + lastName: + type: "string" + CustomerPasswordUpdatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + reset: + type: "boolean" + CustomerTitleSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + title: + type: "string" + DeliveryAddedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + delivery: + $ref: '#/components/schemas/Delivery' + DeliveryAddressSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + deliveryId: + type: "string" + address: + $ref: '#/components/schemas/Address' + oldAddress: + $ref: '#/components/schemas/Address' + DeliveryItemsUpdatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + deliveryId: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + oldItems: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + DeliveryRemovedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + delivery: + $ref: '#/components/schemas/Delivery' + InventoryEntryCreatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + inventoryEntry: + $ref: '#/components/schemas/InventoryEntry' + InventoryEntryDeletedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + sku: + type: "string" + supplyChannel: + $ref: '#/components/schemas/ChannelReference' + InventoryEntryQuantitySetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + oldQuantityOnStock: + type: "integer" + format: "int64" + newQuantityOnStock: + type: "integer" + format: "int64" + oldAvailableQuantity: + type: "integer" + format: "int64" + newAvailableQuantity: + type: "integer" + format: "int64" + supplyChannel: + $ref: '#/components/schemas/ChannelReference' + LineItemStateTransitionMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + lineItemId: + type: "string" + transitionDate: + type: "string" + format: "datetime" + quantity: + type: "integer" + format: "int64" + fromState: + $ref: '#/components/schemas/StateReference' + toState: + $ref: '#/components/schemas/StateReference' + Message: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + discriminator: + propertyName: type + mapping: + CategoryCreated: '#/components/schemas/CategoryCreatedMessage' + CategorySlugChanged: '#/components/schemas/CategorySlugChangedMessage' + CustomLineItemStateTransition: '#/components/schemas/CustomLineItemStateTransitionMessage' + CustomerAddressAdded: '#/components/schemas/CustomerAddressAddedMessage' + CustomerAddressChanged: '#/components/schemas/CustomerAddressChangedMessage' + CustomerAddressRemoved: '#/components/schemas/CustomerAddressRemovedMessage' + CustomerCompanyNameSet: '#/components/schemas/CustomerCompanyNameSetMessage' + CustomerCreated: '#/components/schemas/CustomerCreatedMessage' + CustomerDateOfBirthSet: '#/components/schemas/CustomerDateOfBirthSetMessage' + CustomerDeleted: '#/components/schemas/CustomerDeletedMessage' + CustomerEmailChanged: '#/components/schemas/CustomerEmailChangedMessage' + CustomerEmailVerified: '#/components/schemas/CustomerEmailVerifiedMessage' + CustomerFirstNameSet: '#/components/schemas/CustomerFirstNameSetMessage' + CustomerGroupSet: '#/components/schemas/CustomerGroupSetMessage' + CustomerLastNameSet: '#/components/schemas/CustomerLastNameSetMessage' + CustomerPasswordUpdated: '#/components/schemas/CustomerPasswordUpdatedMessage' + CustomerTitleSet: '#/components/schemas/CustomerTitleSetMessage' + DeliveryAdded: '#/components/schemas/DeliveryAddedMessage' + DeliveryAddressSet: '#/components/schemas/DeliveryAddressSetMessage' + DeliveryItemsUpdated: '#/components/schemas/DeliveryItemsUpdatedMessage' + DeliveryRemoved: '#/components/schemas/DeliveryRemovedMessage' + InventoryEntryCreated: '#/components/schemas/InventoryEntryCreatedMessage' + InventoryEntryDeleted: '#/components/schemas/InventoryEntryDeletedMessage' + InventoryEntryQuantitySet: '#/components/schemas/InventoryEntryQuantitySetMessage' + LineItemStateTransition: '#/components/schemas/LineItemStateTransitionMessage' + OrderBillingAddressSet: '#/components/schemas/OrderBillingAddressSetMessage' + OrderCreated: '#/components/schemas/OrderCreatedMessage' + OrderCustomLineItemDiscountSet: '#/components/schemas/OrderCustomLineItemDiscountSetMessage' + OrderCustomerEmailSet: '#/components/schemas/OrderCustomerEmailSetMessage' + OrderCustomerGroupSet: '#/components/schemas/OrderCustomerGroupSetMessage' + OrderCustomerSet: '#/components/schemas/OrderCustomerSetMessage' + OrderDeleted: '#/components/schemas/OrderDeletedMessage' + OrderDiscountCodeAdded: '#/components/schemas/OrderDiscountCodeAddedMessage' + OrderDiscountCodeRemoved: '#/components/schemas/OrderDiscountCodeRemovedMessage' + OrderDiscountCodeStateSet: '#/components/schemas/OrderDiscountCodeStateSetMessage' + OrderEditApplied: '#/components/schemas/OrderEditAppliedMessage' + OrderImported: '#/components/schemas/OrderImportedMessage' + OrderLineItemAdded: '#/components/schemas/OrderLineItemAddedMessage' + OrderLineItemDiscountSet: '#/components/schemas/OrderLineItemDiscountSetMessage' + OrderLineItemDistributionChannelSet: '#/components/schemas/OrderLineItemDistributionChannelSetMessage' + OrderLineItemRemoved: '#/components/schemas/OrderLineItemRemovedMessage' + OrderPaymentAdded: '#/components/schemas/OrderPaymentAddedMessage' + OrderPaymentStateChanged: '#/components/schemas/OrderPaymentStateChangedMessage' + ReturnInfoAdded: '#/components/schemas/OrderReturnInfoAddedMessage' + ReturnInfoSet: '#/components/schemas/OrderReturnInfoSetMessage' + OrderReturnShipmentStateChanged: '#/components/schemas/OrderReturnShipmentStateChangedMessage' + OrderShipmentStateChanged: '#/components/schemas/OrderShipmentStateChangedMessage' + OrderShippingAddressSet: '#/components/schemas/OrderShippingAddressSetMessage' + OrderShippingInfoSet: '#/components/schemas/OrderShippingInfoSetMessage' + OrderShippingRateInputSet: '#/components/schemas/OrderShippingRateInputSetMessage' + OrderStateChanged: '#/components/schemas/OrderStateChangedMessage' + OrderStateTransition: '#/components/schemas/OrderStateTransitionMessage' + OrderStoreSet: '#/components/schemas/OrderStoreSetMessage' + ParcelAddedToDelivery: '#/components/schemas/ParcelAddedToDeliveryMessage' + ParcelItemsUpdated: '#/components/schemas/ParcelItemsUpdatedMessage' + ParcelMeasurementsUpdated: '#/components/schemas/ParcelMeasurementsUpdatedMessage' + ParcelRemovedFromDelivery: '#/components/schemas/ParcelRemovedFromDeliveryMessage' + ParcelTrackingDataUpdated: '#/components/schemas/ParcelTrackingDataUpdatedMessage' + PaymentCreated: '#/components/schemas/PaymentCreatedMessage' + PaymentInteractionAdded: '#/components/schemas/PaymentInteractionAddedMessage' + PaymentStatusInterfaceCodeSet: '#/components/schemas/PaymentStatusInterfaceCodeSetMessage' + PaymentStatusStateTransition: '#/components/schemas/PaymentStatusStateTransitionMessage' + PaymentTransactionAdded: '#/components/schemas/PaymentTransactionAddedMessage' + PaymentTransactionStateChanged: '#/components/schemas/PaymentTransactionStateChangedMessage' + ProductAddedToCategory: '#/components/schemas/ProductAddedToCategoryMessage' + ProductCreated: '#/components/schemas/ProductCreatedMessage' + ProductDeleted: '#/components/schemas/ProductDeletedMessage' + ProductImageAdded: '#/components/schemas/ProductImageAddedMessage' + ProductPriceDiscountsSet: '#/components/schemas/ProductPriceDiscountsSetMessage' + ProductPriceExternalDiscountSet: '#/components/schemas/ProductPriceExternalDiscountSetMessage' + ProductPublished: '#/components/schemas/ProductPublishedMessage' + ProductRemovedFromCategory: '#/components/schemas/ProductRemovedFromCategoryMessage' + ProductRevertedStagedChanges: '#/components/schemas/ProductRevertedStagedChangesMessage' + ProductSelectionCreated: '#/components/schemas/ProductSelectionCreatedMessage' + ProductSelectionDeleted: '#/components/schemas/ProductSelectionDeletedMessage' + ProductSelectionProductAdded: '#/components/schemas/ProductSelectionProductAddedMessage' + ProductSelectionProductRemoved: '#/components/schemas/ProductSelectionProductRemovedMessage' + ProductSlugChanged: '#/components/schemas/ProductSlugChangedMessage' + ProductStateTransition: '#/components/schemas/ProductStateTransitionMessage' + ProductUnpublished: '#/components/schemas/ProductUnpublishedMessage' + ProductVariantAdded: '#/components/schemas/ProductVariantAddedMessage' + ProductVariantDeleted: '#/components/schemas/ProductVariantDeletedMessage' + ReviewCreated: '#/components/schemas/ReviewCreatedMessage' + ReviewRatingSet: '#/components/schemas/ReviewRatingSetMessage' + ReviewStateTransition: '#/components/schemas/ReviewStateTransitionMessage' + StoreCreated: '#/components/schemas/StoreCreatedMessage' + StoreDeleted: '#/components/schemas/StoreDeletedMessage' + StoreProductSelectionsChanged: '#/components/schemas/StoreProductSelectionsChangedMessage' + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + MessageConfiguration: + type: "object" + properties: + enabled: + type: "boolean" + deleteDaysAfterCreation: + type: "integer" + format: "int32" + MessageConfigurationDraft: + type: "object" + properties: + enabled: + type: "boolean" + deleteDaysAfterCreation: + type: "integer" + format: "int32" + MessagePagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Message' + OrderBillingAddressSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + address: + $ref: '#/components/schemas/Address' + oldAddress: + $ref: '#/components/schemas/Address' + OrderCreatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + order: + $ref: '#/components/schemas/Order' + OrderCustomLineItemDiscountSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + customLineItemId: + type: "string" + discountedPricePerQuantity: + type: "array" + items: + $ref: '#/components/schemas/DiscountedLineItemPriceForQuantity' + taxedPrice: + $ref: '#/components/schemas/TaxedItemPrice' + OrderCustomerEmailSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + email: + type: "string" + oldEmail: + type: "string" + OrderCustomerGroupSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + oldCustomerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + OrderCustomerSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + customer: + $ref: '#/components/schemas/CustomerReference' + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + oldCustomer: + $ref: '#/components/schemas/CustomerReference' + oldCustomerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + OrderDeletedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + order: + $ref: '#/components/schemas/Order' + OrderDiscountCodeAddedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + discountCode: + $ref: '#/components/schemas/DiscountCodeReference' + OrderDiscountCodeRemovedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + discountCode: + $ref: '#/components/schemas/DiscountCodeReference' + OrderDiscountCodeStateSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + discountCode: + $ref: '#/components/schemas/DiscountCodeReference' + state: + $ref: '#/components/schemas/DiscountCodeState' + oldState: + $ref: '#/components/schemas/DiscountCodeState' + OrderEditAppliedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + edit: + $ref: '#/components/schemas/OrderEditReference' + result: + $ref: '#/components/schemas/OrderEditApplied' + OrderImportedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + order: + $ref: '#/components/schemas/Order' + OrderLineItemAddedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + lineItem: + $ref: '#/components/schemas/LineItem' + addedQuantity: + type: "integer" + format: "int64" + OrderLineItemDiscountSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + lineItemId: + type: "string" + discountedPricePerQuantity: + type: "array" + items: + $ref: '#/components/schemas/DiscountedLineItemPriceForQuantity' + totalPrice: + $ref: '#/components/schemas/Money' + taxedPrice: + $ref: '#/components/schemas/TaxedItemPrice' + OrderLineItemDistributionChannelSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + lineItemId: + type: "string" + distributionChannel: + $ref: '#/components/schemas/ChannelReference' + OrderLineItemRemovedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + lineItemId: + type: "string" + removedQuantity: + type: "integer" + format: "int64" + newQuantity: + type: "integer" + format: "int64" + newState: + type: "array" + items: + $ref: '#/components/schemas/ItemState' + newTotalPrice: + $ref: '#/components/schemas/TypedMoney' + newTaxedPrice: + $ref: '#/components/schemas/TaxedItemPrice' + newPrice: + $ref: '#/components/schemas/Price' + newShippingDetail: + $ref: '#/components/schemas/ItemShippingDetails' + OrderPaymentAddedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + payment: + $ref: '#/components/schemas/PaymentReference' + OrderPaymentStateChangedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + paymentState: + $ref: '#/components/schemas/PaymentState' + oldPaymentState: + $ref: '#/components/schemas/PaymentState' + OrderReturnInfoAddedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + returnInfo: + $ref: '#/components/schemas/ReturnInfo' + OrderReturnInfoSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + returnInfo: + type: "array" + items: + $ref: '#/components/schemas/ReturnInfo' + OrderReturnShipmentStateChangedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + returnItemId: + type: "string" + returnShipmentState: + $ref: '#/components/schemas/ReturnShipmentState' + OrderShipmentStateChangedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + shipmentState: + $ref: '#/components/schemas/ShipmentState' + oldShipmentState: + $ref: '#/components/schemas/ShipmentState' + OrderShippingAddressSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + address: + $ref: '#/components/schemas/Address' + oldAddress: + $ref: '#/components/schemas/Address' + OrderShippingInfoSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + shippingInfo: + $ref: '#/components/schemas/ShippingInfo' + oldShippingInfo: + $ref: '#/components/schemas/ShippingInfo' + OrderShippingRateInputSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + shippingRateInput: + $ref: '#/components/schemas/ShippingRateInput' + oldShippingRateInput: + $ref: '#/components/schemas/ShippingRateInput' + OrderStateChangedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + orderState: + $ref: '#/components/schemas/OrderState' + oldOrderState: + $ref: '#/components/schemas/OrderState' + OrderStateTransitionMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + state: + $ref: '#/components/schemas/StateReference' + oldState: + $ref: '#/components/schemas/StateReference' + force: + type: "boolean" + OrderStoreSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + store: + $ref: '#/components/schemas/StoreKeyReference' + ParcelAddedToDeliveryMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + delivery: + $ref: '#/components/schemas/Delivery' + parcel: + $ref: '#/components/schemas/Parcel' + ParcelItemsUpdatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + parcelId: + type: "string" + deliveryId: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + oldItems: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + ParcelMeasurementsUpdatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + deliveryId: + type: "string" + parcelId: + type: "string" + measurements: + $ref: '#/components/schemas/ParcelMeasurements' + ParcelRemovedFromDeliveryMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + deliveryId: + type: "string" + parcel: + $ref: '#/components/schemas/Parcel' + ParcelTrackingDataUpdatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + deliveryId: + type: "string" + parcelId: + type: "string" + trackingData: + $ref: '#/components/schemas/TrackingData' + PaymentCreatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + payment: + $ref: '#/components/schemas/Payment' + PaymentInteractionAddedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + interaction: + $ref: '#/components/schemas/CustomFields' + PaymentStatusInterfaceCodeSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + paymentId: + type: "string" + interfaceCode: + type: "string" + PaymentStatusStateTransitionMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + state: + $ref: '#/components/schemas/StateReference' + force: + type: "boolean" + PaymentTransactionAddedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + transaction: + $ref: '#/components/schemas/Transaction' + PaymentTransactionStateChangedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + transactionId: + type: "string" + state: + $ref: '#/components/schemas/TransactionState' + ProductAddedToCategoryMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + category: + $ref: '#/components/schemas/CategoryReference' + staged: + type: "boolean" + ProductCreatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + productProjection: + $ref: '#/components/schemas/ProductProjection' + ProductDeletedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + removedImageUrls: + type: "array" + items: + type: "string" + currentProjection: + $ref: '#/components/schemas/ProductProjection' + ProductImageAddedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + variantId: + type: "integer" + format: "int64" + image: + $ref: '#/components/schemas/Image' + staged: + type: "boolean" + ProductPriceDiscountsSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + updatedPrices: + type: "array" + items: + $ref: '#/components/schemas/ProductPriceDiscountsSetUpdatedPrice' + ProductPriceDiscountsSetUpdatedPrice: + type: "object" + properties: + variantId: + type: "integer" + format: "int32" + variantKey: + type: "string" + sku: + type: "string" + priceId: + type: "string" + discounted: + $ref: '#/components/schemas/DiscountedPrice' + staged: + type: "boolean" + ProductPriceExternalDiscountSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + variantId: + type: "integer" + format: "int32" + variantKey: + type: "string" + sku: + type: "string" + priceId: + type: "string" + discounted: + $ref: '#/components/schemas/DiscountedPrice' + staged: + type: "boolean" + ProductPublishedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + removedImageUrls: + type: "array" + items: + type: "string" + productProjection: + $ref: '#/components/schemas/ProductProjection' + scope: + $ref: '#/components/schemas/ProductPublishScope' + ProductRemovedFromCategoryMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + category: + $ref: '#/components/schemas/CategoryReference' + staged: + type: "boolean" + ProductRevertedStagedChangesMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + removedImageUrls: + type: "array" + items: + type: "string" + ProductSelectionCreatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + productSelection: + $ref: '#/components/schemas/ProductSelectionType' + ProductSelectionDeletedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + name: + $ref: '#/components/schemas/LocalizedString' + ProductSelectionProductAddedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + product: + $ref: '#/components/schemas/ProductReference' + ProductSelectionProductRemovedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + product: + $ref: '#/components/schemas/ProductReference' + ProductSlugChangedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + slug: + $ref: '#/components/schemas/LocalizedString' + oldSlug: + $ref: '#/components/schemas/LocalizedString' + ProductStateTransitionMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + state: + $ref: '#/components/schemas/StateReference' + force: + type: "boolean" + ProductUnpublishedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + ProductVariantAddedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + variant: + $ref: '#/components/schemas/ProductVariant' + staged: + type: "boolean" + ProductVariantDeletedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + variant: + $ref: '#/components/schemas/ProductVariant' + removedImageUrls: + type: "array" + items: + type: "string" + ReviewCreatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + review: + $ref: '#/components/schemas/Review' + ReviewRatingSetMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + oldRating: + type: "number" + format: "double" + newRating: + type: "number" + format: "double" + includedInStatistics: + type: "boolean" + target: + $ref: '#/components/schemas/Reference' + ReviewStateTransitionMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + oldState: + $ref: '#/components/schemas/StateReference' + newState: + $ref: '#/components/schemas/StateReference' + oldIncludedInStatistics: + type: "boolean" + newIncludedInStatistics: + type: "boolean" + target: + $ref: '#/components/schemas/Reference' + force: + type: "boolean" + StoreCreatedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + name: + $ref: '#/components/schemas/LocalizedString' + languages: + type: "array" + items: + type: "string" + distributionChannels: + type: "array" + items: + $ref: '#/components/schemas/ChannelReference' + supplyChannels: + type: "array" + items: + $ref: '#/components/schemas/ChannelReference' + productSelections: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionSetting' + custom: + $ref: '#/components/schemas/CustomFields' + StoreDeletedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + StoreProductSelectionsChangedMessage: + allOf: + - $ref: '#/components/schemas/Message' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + sequenceNumber: + type: "integer" + format: "int64" + resource: + $ref: '#/components/schemas/Reference' + resourceVersion: + type: "integer" + format: "int64" + type: + type: "string" + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + addedProductSelections: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionSetting' + removedProductSelections: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionSetting' + updatedProductSelections: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionSetting' + UserProvidedIdentifiers: + type: "object" + properties: + key: + type: "string" + externalId: + type: "string" + orderNumber: + type: "string" + customerNumber: + type: "string" + sku: + type: "string" + slug: + $ref: '#/components/schemas/LocalizedString' + containerAndKey: + $ref: '#/components/schemas/ContainerAndKey' + CategoryCreatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + category: + $ref: '#/components/schemas/Category' + CategorySlugChangedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + slug: + $ref: '#/components/schemas/LocalizedString' + oldSlug: + $ref: '#/components/schemas/LocalizedString' + CustomLineItemStateTransitionMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + customLineItemId: + type: "string" + transitionDate: + type: "string" + format: "datetime" + quantity: + type: "integer" + format: "int64" + fromState: + $ref: '#/components/schemas/StateReference' + toState: + $ref: '#/components/schemas/StateReference' + CustomerAddressAddedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + address: + $ref: '#/components/schemas/Address' + CustomerAddressChangedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + address: + $ref: '#/components/schemas/Address' + CustomerAddressRemovedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + address: + $ref: '#/components/schemas/Address' + CustomerCompanyNameSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + companyName: + type: "string" + CustomerCreatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + customer: + $ref: '#/components/schemas/Customer' + CustomerDateOfBirthSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + dateOfBirth: + type: "string" + format: "date-only" + CustomerDeletedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + CustomerEmailChangedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + email: + type: "string" + CustomerEmailVerifiedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + CustomerFirstNameSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + firstName: + type: "string" + CustomerGroupSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + CustomerLastNameSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + lastName: + type: "string" + CustomerPasswordUpdatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + reset: + type: "boolean" + CustomerTitleSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + title: + type: "string" + DeliveryAddedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + delivery: + $ref: '#/components/schemas/Delivery' + DeliveryAddressSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + deliveryId: + type: "string" + address: + $ref: '#/components/schemas/Address' + oldAddress: + $ref: '#/components/schemas/Address' + DeliveryItemsUpdatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + deliveryId: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + oldItems: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + DeliveryRemovedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + delivery: + $ref: '#/components/schemas/Delivery' + InventoryEntryCreatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + inventoryEntry: + $ref: '#/components/schemas/InventoryEntry' + InventoryEntryDeletedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + sku: + type: "string" + supplyChannel: + $ref: '#/components/schemas/ChannelReference' + InventoryEntryQuantitySetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + oldQuantityOnStock: + type: "integer" + format: "int64" + newQuantityOnStock: + type: "integer" + format: "int64" + oldAvailableQuantity: + type: "integer" + format: "int64" + newAvailableQuantity: + type: "integer" + format: "int64" + supplyChannel: + $ref: '#/components/schemas/ChannelReference' + LineItemStateTransitionMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + lineItemId: + type: "string" + transitionDate: + type: "string" + format: "datetime" + quantity: + type: "integer" + format: "int64" + fromState: + $ref: '#/components/schemas/StateReference' + toState: + $ref: '#/components/schemas/StateReference' + MessagePayload: + type: "object" + discriminator: + propertyName: type + mapping: + CategoryCreated: '#/components/schemas/CategoryCreatedMessagePayload' + CategorySlugChanged: '#/components/schemas/CategorySlugChangedMessagePayload' + CustomLineItemStateTransition: '#/components/schemas/CustomLineItemStateTransitionMessagePayload' + CustomerAddressAdded: '#/components/schemas/CustomerAddressAddedMessagePayload' + CustomerAddressChanged: '#/components/schemas/CustomerAddressChangedMessagePayload' + CustomerAddressRemoved: '#/components/schemas/CustomerAddressRemovedMessagePayload' + CustomerCompanyNameSet: '#/components/schemas/CustomerCompanyNameSetMessagePayload' + CustomerCreated: '#/components/schemas/CustomerCreatedMessagePayload' + CustomerDateOfBirthSet: '#/components/schemas/CustomerDateOfBirthSetMessagePayload' + CustomerDeleted: '#/components/schemas/CustomerDeletedMessagePayload' + CustomerEmailChanged: '#/components/schemas/CustomerEmailChangedMessagePayload' + CustomerEmailVerified: '#/components/schemas/CustomerEmailVerifiedMessagePayload' + CustomerFirstNameSet: '#/components/schemas/CustomerFirstNameSetMessagePayload' + CustomerGroupSet: '#/components/schemas/CustomerGroupSetMessagePayload' + CustomerLastNameSet: '#/components/schemas/CustomerLastNameSetMessagePayload' + CustomerPasswordUpdated: '#/components/schemas/CustomerPasswordUpdatedMessagePayload' + CustomerTitleSet: '#/components/schemas/CustomerTitleSetMessagePayload' + DeliveryAdded: '#/components/schemas/DeliveryAddedMessagePayload' + DeliveryAddressSet: '#/components/schemas/DeliveryAddressSetMessagePayload' + DeliveryItemsUpdated: '#/components/schemas/DeliveryItemsUpdatedMessagePayload' + DeliveryRemoved: '#/components/schemas/DeliveryRemovedMessagePayload' + InventoryEntryCreated: '#/components/schemas/InventoryEntryCreatedMessagePayload' + InventoryEntryDeleted: '#/components/schemas/InventoryEntryDeletedMessagePayload' + InventoryEntryQuantitySet: '#/components/schemas/InventoryEntryQuantitySetMessagePayload' + LineItemStateTransition: '#/components/schemas/LineItemStateTransitionMessagePayload' + OrderBillingAddressSet: '#/components/schemas/OrderBillingAddressSetMessagePayload' + OrderCreated: '#/components/schemas/OrderCreatedMessagePayload' + OrderCustomLineItemDiscountSet: '#/components/schemas/OrderCustomLineItemDiscountSetMessagePayload' + OrderCustomerEmailSet: '#/components/schemas/OrderCustomerEmailSetMessagePayload' + OrderCustomerGroupSet: '#/components/schemas/OrderCustomerGroupSetMessagePayload' + OrderCustomerSet: '#/components/schemas/OrderCustomerSetMessagePayload' + OrderDeleted: '#/components/schemas/OrderDeletedMessagePayload' + OrderDiscountCodeAdded: '#/components/schemas/OrderDiscountCodeAddedMessagePayload' + OrderDiscountCodeRemoved: '#/components/schemas/OrderDiscountCodeRemovedMessagePayload' + OrderDiscountCodeStateSet: '#/components/schemas/OrderDiscountCodeStateSetMessagePayload' + OrderEditApplied: '#/components/schemas/OrderEditAppliedMessagePayload' + OrderImported: '#/components/schemas/OrderImportedMessagePayload' + OrderLineItemAdded: '#/components/schemas/OrderLineItemAddedMessagePayload' + OrderLineItemDiscountSet: '#/components/schemas/OrderLineItemDiscountSetMessagePayload' + OrderLineItemDistributionChannelSet: '#/components/schemas/OrderLineItemDistributionChannelSetMessagePayload' + OrderLineItemRemoved: '#/components/schemas/OrderLineItemRemovedMessagePayload' + OrderPaymentAdded: '#/components/schemas/OrderPaymentAddedMessagePayload' + OrderPaymentStateChanged: '#/components/schemas/OrderPaymentStateChangedMessagePayload' + ReturnInfoAdded: '#/components/schemas/OrderReturnInfoAddedMessagePayload' + ReturnInfoSet: '#/components/schemas/OrderReturnInfoSetMessagePayload' + OrderReturnShipmentStateChanged: '#/components/schemas/OrderReturnShipmentStateChangedMessagePayload' + OrderShipmentStateChanged: '#/components/schemas/OrderShipmentStateChangedMessagePayload' + OrderShippingAddressSet: '#/components/schemas/OrderShippingAddressSetMessagePayload' + OrderShippingInfoSet: '#/components/schemas/OrderShippingInfoSetMessagePayload' + OrderShippingRateInputSet: '#/components/schemas/OrderShippingRateInputSetMessagePayload' + OrderStateChanged: '#/components/schemas/OrderStateChangedMessagePayload' + OrderStateTransition: '#/components/schemas/OrderStateTransitionMessagePayload' + OrderStoreSet: '#/components/schemas/OrderStoreSetMessagePayload' + ParcelAddedToDelivery: '#/components/schemas/ParcelAddedToDeliveryMessagePayload' + ParcelItemsUpdated: '#/components/schemas/ParcelItemsUpdatedMessagePayload' + ParcelMeasurementsUpdated: '#/components/schemas/ParcelMeasurementsUpdatedMessagePayload' + ParcelRemovedFromDelivery: '#/components/schemas/ParcelRemovedFromDeliveryMessagePayload' + ParcelTrackingDataUpdated: '#/components/schemas/ParcelTrackingDataUpdatedMessagePayload' + PaymentCreated: '#/components/schemas/PaymentCreatedMessagePayload' + PaymentInteractionAdded: '#/components/schemas/PaymentInteractionAddedMessagePayload' + PaymentStatusInterfaceCodeSet: '#/components/schemas/PaymentStatusInterfaceCodeSetMessagePayload' + PaymentStatusStateTransition: '#/components/schemas/PaymentStatusStateTransitionMessagePayload' + PaymentTransactionAdded: '#/components/schemas/PaymentTransactionAddedMessagePayload' + PaymentTransactionStateChanged: '#/components/schemas/PaymentTransactionStateChangedMessagePayload' + ProductAddedToCategory: '#/components/schemas/ProductAddedToCategoryMessagePayload' + ProductCreated: '#/components/schemas/ProductCreatedMessagePayload' + ProductDeleted: '#/components/schemas/ProductDeletedMessagePayload' + ProductImageAdded: '#/components/schemas/ProductImageAddedMessagePayload' + ProductPriceDiscountsSet: '#/components/schemas/ProductPriceDiscountsSetMessagePayload' + ProductPriceExternalDiscountSet: '#/components/schemas/ProductPriceExternalDiscountSetMessagePayload' + ProductPublished: '#/components/schemas/ProductPublishedMessagePayload' + ProductRemovedFromCategory: '#/components/schemas/ProductRemovedFromCategoryMessagePayload' + ProductRevertedStagedChanges: '#/components/schemas/ProductRevertedStagedChangesMessagePayload' + ProductSelectionCreated: '#/components/schemas/ProductSelectionCreatedMessagePayload' + ProductSelectionDeleted: '#/components/schemas/ProductSelectionDeletedMessagePayload' + ProductSelectionProductAdded: '#/components/schemas/ProductSelectionProductAddedMessagePayload' + ProductSelectionProductRemoved: '#/components/schemas/ProductSelectionProductRemovedMessagePayload' + ProductSlugChanged: '#/components/schemas/ProductSlugChangedMessagePayload' + ProductStateTransition: '#/components/schemas/ProductStateTransitionMessagePayload' + ProductUnpublished: '#/components/schemas/ProductUnpublishedMessagePayload' + ProductVariantAdded: '#/components/schemas/ProductVariantAddedMessagePayload' + ProductVariantDeleted: '#/components/schemas/ProductVariantDeletedMessagePayload' + ReviewCreated: '#/components/schemas/ReviewCreatedMessagePayload' + ReviewRatingSet: '#/components/schemas/ReviewRatingSetMessagePayload' + ReviewStateTransition: '#/components/schemas/ReviewStateTransitionMessagePayload' + ShoppingListStoreSet: '#/components/schemas/ShoppingListStoreSetMessagePayload' + StoreCreated: '#/components/schemas/StoreCreatedMessagePayload' + StoreDeleted: '#/components/schemas/StoreDeletedMessagePayload' + StoreProductSelectionsChanged: '#/components/schemas/StoreProductSelectionsChangedMessagePayload' + properties: + type: + type: "string" + OrderBillingAddressSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + address: + $ref: '#/components/schemas/Address' + oldAddress: + $ref: '#/components/schemas/Address' + OrderCreatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + order: + $ref: '#/components/schemas/Order' + OrderCustomLineItemDiscountSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + customLineItemId: + type: "string" + discountedPricePerQuantity: + type: "array" + items: + $ref: '#/components/schemas/DiscountedLineItemPriceForQuantity' + taxedPrice: + $ref: '#/components/schemas/TaxedItemPrice' + OrderCustomerEmailSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + email: + type: "string" + oldEmail: + type: "string" + OrderCustomerGroupSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + oldCustomerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + OrderCustomerSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + customer: + $ref: '#/components/schemas/CustomerReference' + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + oldCustomer: + $ref: '#/components/schemas/CustomerReference' + oldCustomerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + OrderDeletedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + order: + $ref: '#/components/schemas/Order' + OrderDiscountCodeAddedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + discountCode: + $ref: '#/components/schemas/DiscountCodeReference' + OrderDiscountCodeRemovedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + discountCode: + $ref: '#/components/schemas/DiscountCodeReference' + OrderDiscountCodeStateSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + discountCode: + $ref: '#/components/schemas/DiscountCodeReference' + state: + $ref: '#/components/schemas/DiscountCodeState' + oldState: + $ref: '#/components/schemas/DiscountCodeState' + OrderEditAppliedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + edit: + $ref: '#/components/schemas/OrderEditReference' + result: + $ref: '#/components/schemas/OrderEditApplied' + OrderImportedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + order: + $ref: '#/components/schemas/Order' + OrderLineItemAddedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + lineItem: + $ref: '#/components/schemas/LineItem' + addedQuantity: + type: "integer" + format: "int64" + OrderLineItemDiscountSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + lineItemId: + type: "string" + discountedPricePerQuantity: + type: "array" + items: + $ref: '#/components/schemas/DiscountedLineItemPriceForQuantity' + totalPrice: + $ref: '#/components/schemas/Money' + taxedPrice: + $ref: '#/components/schemas/TaxedItemPrice' + OrderLineItemDistributionChannelSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + lineItemId: + type: "string" + distributionChannel: + $ref: '#/components/schemas/ChannelReference' + OrderLineItemRemovedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + lineItemId: + type: "string" + removedQuantity: + type: "integer" + format: "int64" + newQuantity: + type: "integer" + format: "int64" + newState: + type: "array" + items: + $ref: '#/components/schemas/ItemState' + newTotalPrice: + $ref: '#/components/schemas/TypedMoney' + newTaxedPrice: + $ref: '#/components/schemas/TaxedItemPrice' + newPrice: + $ref: '#/components/schemas/Price' + newShippingDetail: + $ref: '#/components/schemas/ItemShippingDetails' + OrderPaymentAddedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + payment: + $ref: '#/components/schemas/PaymentReference' + OrderPaymentStateChangedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + paymentState: + $ref: '#/components/schemas/PaymentState' + oldPaymentState: + $ref: '#/components/schemas/PaymentState' + OrderReturnInfoAddedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + returnInfo: + $ref: '#/components/schemas/ReturnInfo' + OrderReturnInfoSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + returnInfo: + type: "array" + items: + $ref: '#/components/schemas/ReturnInfo' + OrderReturnShipmentStateChangedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + returnItemId: + type: "string" + returnShipmentState: + $ref: '#/components/schemas/ReturnShipmentState' + OrderShipmentStateChangedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + shipmentState: + $ref: '#/components/schemas/ShipmentState' + oldShipmentState: + $ref: '#/components/schemas/ShipmentState' + OrderShippingAddressSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + address: + $ref: '#/components/schemas/Address' + oldAddress: + $ref: '#/components/schemas/Address' + OrderShippingInfoSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + shippingInfo: + $ref: '#/components/schemas/ShippingInfo' + oldShippingInfo: + $ref: '#/components/schemas/ShippingInfo' + OrderShippingRateInputSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + shippingRateInput: + $ref: '#/components/schemas/ShippingRateInput' + oldShippingRateInput: + $ref: '#/components/schemas/ShippingRateInput' + OrderStateChangedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + orderState: + $ref: '#/components/schemas/OrderState' + oldOrderState: + $ref: '#/components/schemas/OrderState' + OrderStateTransitionMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + state: + $ref: '#/components/schemas/StateReference' + oldState: + $ref: '#/components/schemas/StateReference' + force: + type: "boolean" + OrderStoreSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + store: + $ref: '#/components/schemas/StoreKeyReference' + ParcelAddedToDeliveryMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + delivery: + $ref: '#/components/schemas/Delivery' + parcel: + $ref: '#/components/schemas/Parcel' + ParcelItemsUpdatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + parcelId: + type: "string" + deliveryId: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + oldItems: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + ParcelMeasurementsUpdatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + deliveryId: + type: "string" + parcelId: + type: "string" + measurements: + $ref: '#/components/schemas/ParcelMeasurements' + ParcelRemovedFromDeliveryMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + deliveryId: + type: "string" + parcel: + $ref: '#/components/schemas/Parcel' + ParcelTrackingDataUpdatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + deliveryId: + type: "string" + parcelId: + type: "string" + trackingData: + $ref: '#/components/schemas/TrackingData' + PaymentCreatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + payment: + $ref: '#/components/schemas/Payment' + PaymentInteractionAddedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + interaction: + $ref: '#/components/schemas/CustomFields' + PaymentStatusInterfaceCodeSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + paymentId: + type: "string" + interfaceCode: + type: "string" + PaymentStatusStateTransitionMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + state: + $ref: '#/components/schemas/StateReference' + force: + type: "boolean" + PaymentTransactionAddedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + transaction: + $ref: '#/components/schemas/Transaction' + PaymentTransactionStateChangedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + transactionId: + type: "string" + state: + $ref: '#/components/schemas/TransactionState' + ProductAddedToCategoryMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + category: + $ref: '#/components/schemas/CategoryReference' + staged: + type: "boolean" + ProductCreatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + productProjection: + $ref: '#/components/schemas/ProductProjection' + ProductDeletedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + removedImageUrls: + type: "array" + items: + type: "string" + currentProjection: + $ref: '#/components/schemas/ProductProjection' + ProductImageAddedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + variantId: + type: "integer" + format: "int64" + image: + $ref: '#/components/schemas/Image' + staged: + type: "boolean" + ProductPriceDiscountsSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + updatedPrices: + type: "array" + items: + $ref: '#/components/schemas/ProductPriceDiscountsSetUpdatedPrice' + ProductPriceExternalDiscountSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + variantId: + type: "integer" + format: "int32" + variantKey: + type: "string" + sku: + type: "string" + priceId: + type: "string" + discounted: + $ref: '#/components/schemas/DiscountedPrice' + staged: + type: "boolean" + ProductPublishedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + removedImageUrls: + type: "array" + items: + type: "string" + productProjection: + $ref: '#/components/schemas/ProductProjection' + scope: + $ref: '#/components/schemas/ProductPublishScope' + ProductRemovedFromCategoryMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + category: + $ref: '#/components/schemas/CategoryReference' + staged: + type: "boolean" + ProductRevertedStagedChangesMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + removedImageUrls: + type: "array" + items: + type: "string" + ProductSelectionCreatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + productSelection: + $ref: '#/components/schemas/ProductSelectionType' + ProductSelectionDeletedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + ProductSelectionProductAddedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + product: + $ref: '#/components/schemas/ProductReference' + ProductSelectionProductRemovedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + product: + $ref: '#/components/schemas/ProductReference' + ProductSlugChangedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + slug: + $ref: '#/components/schemas/LocalizedString' + oldSlug: + $ref: '#/components/schemas/LocalizedString' + ProductStateTransitionMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + state: + $ref: '#/components/schemas/StateReference' + force: + type: "boolean" + ProductUnpublishedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + ProductVariantAddedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + variant: + $ref: '#/components/schemas/ProductVariant' + staged: + type: "boolean" + ProductVariantDeletedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + variant: + $ref: '#/components/schemas/ProductVariant' + removedImageUrls: + type: "array" + items: + type: "string" + ReviewCreatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + review: + $ref: '#/components/schemas/Review' + ReviewRatingSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + oldRating: + type: "number" + format: "double" + newRating: + type: "number" + format: "double" + includedInStatistics: + type: "boolean" + target: + $ref: '#/components/schemas/Reference' + ReviewStateTransitionMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + oldState: + $ref: '#/components/schemas/StateReference' + newState: + $ref: '#/components/schemas/StateReference' + oldIncludedInStatistics: + type: "boolean" + newIncludedInStatistics: + type: "boolean" + target: + $ref: '#/components/schemas/Reference' + force: + type: "boolean" + ShoppingListStoreSetMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + store: + $ref: '#/components/schemas/StoreKeyReference' + StoreCreatedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + languages: + type: "array" + items: + type: "string" + distributionChannels: + type: "array" + items: + $ref: '#/components/schemas/ChannelReference' + supplyChannels: + type: "array" + items: + $ref: '#/components/schemas/ChannelReference' + productSelections: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionSetting' + custom: + $ref: '#/components/schemas/CustomFields' + StoreDeletedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + StoreProductSelectionsChangedMessagePayload: + allOf: + - $ref: '#/components/schemas/MessagePayload' + - type: "object" + properties: + type: + type: "string" + addedProductSelections: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionSetting' + removedProductSelections: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionSetting' + updatedProductSelections: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionSetting' + OrderEdit: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + resource: + $ref: '#/components/schemas/OrderReference' + stagedActions: + type: "array" + items: + $ref: '#/components/schemas/StagedOrderUpdateAction' + custom: + $ref: '#/components/schemas/CustomFields' + result: + $ref: '#/components/schemas/OrderEditResult' + comment: + type: "string" + OrderEditApplied: + allOf: + - $ref: '#/components/schemas/OrderEditResult' + - type: "object" + properties: + type: + type: "string" + appliedAt: + type: "string" + format: "datetime" + excerptBeforeEdit: + $ref: '#/components/schemas/OrderExcerpt' + excerptAfterEdit: + $ref: '#/components/schemas/OrderExcerpt' + OrderEditApply: + type: "object" + properties: + editVersion: + type: "integer" + format: "int32" + resourceVersion: + type: "integer" + format: "int32" + OrderEditDraft: + type: "object" + properties: + key: + type: "string" + resource: + $ref: '#/components/schemas/OrderReference' + stagedActions: + type: "array" + items: + $ref: '#/components/schemas/StagedOrderUpdateAction' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + comment: + type: "string" + dryRun: + type: "boolean" + OrderEditNotProcessed: + allOf: + - $ref: '#/components/schemas/OrderEditResult' + - type: "object" + properties: + type: + type: "string" + OrderEditPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/OrderEdit' + OrderEditPreviewFailure: + allOf: + - $ref: '#/components/schemas/OrderEditResult' + - type: "object" + properties: + type: + type: "string" + errors: + type: "array" + items: + $ref: '#/components/schemas/ErrorObject' + OrderEditPreviewSuccess: + allOf: + - $ref: '#/components/schemas/OrderEditResult' + - type: "object" + properties: + type: + type: "string" + preview: + $ref: '#/components/schemas/StagedOrder' + messagePayloads: + type: "array" + items: + $ref: '#/components/schemas/MessagePayload' + OrderEditReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/OrderEdit' + OrderEditResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + OrderEditResult: + type: "object" + discriminator: + propertyName: type + mapping: + Applied: '#/components/schemas/OrderEditApplied' + NotProcessed: '#/components/schemas/OrderEditNotProcessed' + PreviewFailure: '#/components/schemas/OrderEditPreviewFailure' + PreviewSuccess: '#/components/schemas/OrderEditPreviewSuccess' + properties: + type: + type: "string" + OrderEditUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/OrderEditUpdateAction' + dryRun: + type: "boolean" + OrderEditUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addStagedAction: '#/components/schemas/OrderEditAddStagedActionAction' + setComment: '#/components/schemas/OrderEditSetCommentAction' + setCustomField: '#/components/schemas/OrderEditSetCustomFieldAction' + setCustomType: '#/components/schemas/OrderEditSetCustomTypeAction' + setKey: '#/components/schemas/OrderEditSetKeyAction' + setStagedActions: '#/components/schemas/OrderEditSetStagedActionsAction' + properties: + action: + type: "string" + OrderExcerpt: + type: "object" + properties: + totalPrice: + $ref: '#/components/schemas/TypedMoney' + taxedPrice: + $ref: '#/components/schemas/TaxedPrice' + version: + type: "integer" + format: "int32" + StagedOrder: + allOf: + - $ref: '#/components/schemas/Order' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + completedAt: + type: "string" + format: "datetime" + orderNumber: + type: "string" + customerId: + type: "string" + customerEmail: + type: "string" + anonymousId: + type: "string" + store: + $ref: '#/components/schemas/StoreKeyReference' + lineItems: + type: "array" + items: + $ref: '#/components/schemas/LineItem' + customLineItems: + type: "array" + items: + $ref: '#/components/schemas/CustomLineItem' + totalPrice: + $ref: '#/components/schemas/TypedMoney' + taxedPrice: + $ref: '#/components/schemas/TaxedPrice' + shippingAddress: + $ref: '#/components/schemas/Address' + billingAddress: + $ref: '#/components/schemas/Address' + taxMode: + $ref: '#/components/schemas/TaxMode' + taxRoundingMode: + $ref: '#/components/schemas/RoundingMode' + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + country: + type: "string" + orderState: + $ref: '#/components/schemas/OrderState' + state: + $ref: '#/components/schemas/StateReference' + shipmentState: + $ref: '#/components/schemas/ShipmentState' + paymentState: + $ref: '#/components/schemas/PaymentState' + shippingInfo: + $ref: '#/components/schemas/ShippingInfo' + syncInfo: + type: "array" + items: + $ref: '#/components/schemas/SyncInfo' + returnInfo: + type: "array" + items: + $ref: '#/components/schemas/ReturnInfo' + discountCodes: + type: "array" + items: + $ref: '#/components/schemas/DiscountCodeInfo' + lastMessageSequenceNumber: + type: "integer" + format: "int64" + cart: + $ref: '#/components/schemas/CartReference' + custom: + $ref: '#/components/schemas/CustomFields' + paymentInfo: + $ref: '#/components/schemas/PaymentInfo' + locale: + type: "string" + inventoryMode: + $ref: '#/components/schemas/InventoryMode' + origin: + $ref: '#/components/schemas/CartOrigin' + taxCalculationMode: + $ref: '#/components/schemas/TaxCalculationMode' + shippingRateInput: + $ref: '#/components/schemas/ShippingRateInput' + itemShippingAddresses: + type: "array" + items: + $ref: '#/components/schemas/Address' + refusedGifts: + type: "array" + items: + $ref: '#/components/schemas/CartDiscountReference' + StagedOrderUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addCustomLineItem: '#/components/schemas/StagedOrderAddCustomLineItemAction' + addDelivery: '#/components/schemas/StagedOrderAddDeliveryAction' + addDiscountCode: '#/components/schemas/StagedOrderAddDiscountCodeAction' + addItemShippingAddress: '#/components/schemas/StagedOrderAddItemShippingAddressAction' + addLineItem: '#/components/schemas/StagedOrderAddLineItemAction' + addParcelToDelivery: '#/components/schemas/StagedOrderAddParcelToDeliveryAction' + addPayment: '#/components/schemas/StagedOrderAddPaymentAction' + addReturnInfo: '#/components/schemas/StagedOrderAddReturnInfoAction' + addShoppingList: '#/components/schemas/StagedOrderAddShoppingListAction' + changeCustomLineItemMoney: '#/components/schemas/StagedOrderChangeCustomLineItemMoneyAction' + changeCustomLineItemQuantity: '#/components/schemas/StagedOrderChangeCustomLineItemQuantityAction' + changeLineItemQuantity: '#/components/schemas/StagedOrderChangeLineItemQuantityAction' + changeOrderState: '#/components/schemas/StagedOrderChangeOrderStateAction' + changePaymentState: '#/components/schemas/StagedOrderChangePaymentStateAction' + changeShipmentState: '#/components/schemas/StagedOrderChangeShipmentStateAction' + changeTaxCalculationMode: '#/components/schemas/StagedOrderChangeTaxCalculationModeAction' + changeTaxMode: '#/components/schemas/StagedOrderChangeTaxModeAction' + changeTaxRoundingMode: '#/components/schemas/StagedOrderChangeTaxRoundingModeAction' + importCustomLineItemState: '#/components/schemas/StagedOrderImportCustomLineItemStateAction' + importLineItemState: '#/components/schemas/StagedOrderImportLineItemStateAction' + removeCustomLineItem: '#/components/schemas/StagedOrderRemoveCustomLineItemAction' + removeDelivery: '#/components/schemas/StagedOrderRemoveDeliveryAction' + removeDiscountCode: '#/components/schemas/StagedOrderRemoveDiscountCodeAction' + removeItemShippingAddress: '#/components/schemas/StagedOrderRemoveItemShippingAddressAction' + removeLineItem: '#/components/schemas/StagedOrderRemoveLineItemAction' + removeParcelFromDelivery: '#/components/schemas/StagedOrderRemoveParcelFromDeliveryAction' + removePayment: '#/components/schemas/StagedOrderRemovePaymentAction' + setBillingAddress: '#/components/schemas/StagedOrderSetBillingAddressAction' + setBillingAddressCustomField: '#/components/schemas/StagedOrderSetBillingAddressCustomFieldAction' + setBillingAddressCustomType: '#/components/schemas/StagedOrderSetBillingAddressCustomTypeAction' + setCountry: '#/components/schemas/StagedOrderSetCountryAction' + setCustomField: '#/components/schemas/StagedOrderSetCustomFieldAction' + setCustomLineItemCustomField: '#/components/schemas/StagedOrderSetCustomLineItemCustomFieldAction' + setCustomLineItemCustomType: '#/components/schemas/StagedOrderSetCustomLineItemCustomTypeAction' + setCustomLineItemShippingDetails: '#/components/schemas/StagedOrderSetCustomLineItemShippingDetailsAction' + setCustomLineItemTaxAmount: '#/components/schemas/StagedOrderSetCustomLineItemTaxAmountAction' + setCustomLineItemTaxRate: '#/components/schemas/StagedOrderSetCustomLineItemTaxRateAction' + setCustomShippingMethod: '#/components/schemas/StagedOrderSetCustomShippingMethodAction' + setCustomType: '#/components/schemas/StagedOrderSetCustomTypeAction' + setCustomerEmail: '#/components/schemas/StagedOrderSetCustomerEmailAction' + setCustomerGroup: '#/components/schemas/StagedOrderSetCustomerGroupAction' + setCustomerId: '#/components/schemas/StagedOrderSetCustomerIdAction' + setDeliveryAddress: '#/components/schemas/StagedOrderSetDeliveryAddressAction' + setDeliveryAddressCustomField: '#/components/schemas/StagedOrderSetDeliveryAddressCustomFieldAction' + setDeliveryAddressCustomType: '#/components/schemas/StagedOrderSetDeliveryAddressCustomTypeAction' + setDeliveryCustomField: '#/components/schemas/StagedOrderSetDeliveryCustomFieldAction' + setDeliveryCustomType: '#/components/schemas/StagedOrderSetDeliveryCustomTypeAction' + setDeliveryItems: '#/components/schemas/StagedOrderSetDeliveryItemsAction' + setItemShippingAddressCustomField: '#/components/schemas/StagedOrderSetItemShippingAddressCustomFieldAction' + setItemShippingAddressCustomType: '#/components/schemas/StagedOrderSetItemShippingAddressCustomTypeAction' + setLineItemCustomField: '#/components/schemas/StagedOrderSetLineItemCustomFieldAction' + setLineItemCustomType: '#/components/schemas/StagedOrderSetLineItemCustomTypeAction' + setLineItemDistributionChannel: '#/components/schemas/StagedOrderSetLineItemDistributionChannelAction' + setLineItemPrice: '#/components/schemas/StagedOrderSetLineItemPriceAction' + setLineItemShippingDetails: '#/components/schemas/StagedOrderSetLineItemShippingDetailsAction' + setLineItemTaxAmount: '#/components/schemas/StagedOrderSetLineItemTaxAmountAction' + setLineItemTaxRate: '#/components/schemas/StagedOrderSetLineItemTaxRateAction' + setLineItemTotalPrice: '#/components/schemas/StagedOrderSetLineItemTotalPriceAction' + setLocale: '#/components/schemas/StagedOrderSetLocaleAction' + setOrderNumber: '#/components/schemas/StagedOrderSetOrderNumberAction' + setOrderTotalTax: '#/components/schemas/StagedOrderSetOrderTotalTaxAction' + setParcelCustomField: '#/components/schemas/StagedOrderSetParcelCustomFieldAction' + setParcelCustomType: '#/components/schemas/StagedOrderSetParcelCustomTypeAction' + setParcelItems: '#/components/schemas/StagedOrderSetParcelItemsAction' + setParcelMeasurements: '#/components/schemas/StagedOrderSetParcelMeasurementsAction' + setParcelTrackingData: '#/components/schemas/StagedOrderSetParcelTrackingDataAction' + setReturnInfo: '#/components/schemas/StagedOrderSetReturnInfoAction' + setReturnItemCustomField: '#/components/schemas/StagedOrderSetReturnItemCustomFieldAction' + setReturnItemCustomType: '#/components/schemas/StagedOrderSetReturnItemCustomTypeAction' + setReturnPaymentState: '#/components/schemas/StagedOrderSetReturnPaymentStateAction' + setReturnShipmentState: '#/components/schemas/StagedOrderSetReturnShipmentStateAction' + setShippingAddress: '#/components/schemas/StagedOrderSetShippingAddressAction' + setShippingAddressAndCustomShippingMethod: '#/components/schemas/StagedOrderSetShippingAddressAndCustomShippingMethodAction' + setShippingAddressAndShippingMethod: '#/components/schemas/StagedOrderSetShippingAddressAndShippingMethodAction' + setShippingAddressCustomField: '#/components/schemas/StagedOrderSetShippingAddressCustomFieldAction' + setShippingAddressCustomType: '#/components/schemas/StagedOrderSetShippingAddressCustomTypeAction' + setShippingMethod: '#/components/schemas/StagedOrderSetShippingMethodAction' + setShippingMethodTaxAmount: '#/components/schemas/StagedOrderSetShippingMethodTaxAmountAction' + setShippingMethodTaxRate: '#/components/schemas/StagedOrderSetShippingMethodTaxRateAction' + setShippingRateInput: '#/components/schemas/StagedOrderSetShippingRateInputAction' + transitionCustomLineItemState: '#/components/schemas/StagedOrderTransitionCustomLineItemStateAction' + transitionLineItemState: '#/components/schemas/StagedOrderTransitionLineItemStateAction' + transitionState: '#/components/schemas/StagedOrderTransitionStateAction' + updateItemShippingAddress: '#/components/schemas/StagedOrderUpdateItemShippingAddressAction' + updateSyncInfo: '#/components/schemas/StagedOrderUpdateSyncInfoAction' + properties: + action: + type: "string" + OrderEditAddStagedActionAction: + allOf: + - $ref: '#/components/schemas/OrderEditUpdateAction' + - type: "object" + properties: + action: + type: "string" + stagedAction: + $ref: '#/components/schemas/StagedOrderUpdateAction' + OrderEditSetCommentAction: + allOf: + - $ref: '#/components/schemas/OrderEditUpdateAction' + - type: "object" + properties: + action: + type: "string" + comment: + type: "string" + OrderEditSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/OrderEditUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + OrderEditSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/OrderEditUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + type: "string" + additionalProperties: true + OrderEditSetKeyAction: + allOf: + - $ref: '#/components/schemas/OrderEditUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + OrderEditSetStagedActionsAction: + allOf: + - $ref: '#/components/schemas/OrderEditUpdateAction' + - type: "object" + properties: + action: + type: "string" + stagedActions: + type: "array" + items: + $ref: '#/components/schemas/StagedOrderUpdateAction' + StagedOrderAddCustomLineItemAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + money: + $ref: '#/components/schemas/Money' + name: + $ref: '#/components/schemas/LocalizedString' + quantity: + type: "number" + format: "double" + slug: + type: "string" + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + StagedOrderAddDeliveryAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + address: + $ref: '#/components/schemas/BaseAddress' + parcels: + type: "array" + items: + $ref: '#/components/schemas/ParcelDraft' + custom: + $ref: '#/components/schemas/CustomFields' + StagedOrderAddDiscountCodeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + code: + type: "string" + StagedOrderAddItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + StagedOrderAddLineItemAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + productId: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + quantity: + type: "number" + format: "double" + addedAt: + type: "string" + format: "datetime" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + externalPrice: + $ref: '#/components/schemas/Money' + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + StagedOrderAddParcelToDeliveryAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + measurements: + $ref: '#/components/schemas/ParcelMeasurements' + trackingData: + $ref: '#/components/schemas/TrackingData' + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + StagedOrderAddPaymentAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + payment: + $ref: '#/components/schemas/PaymentResourceIdentifier' + StagedOrderAddReturnInfoAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + returnTrackingId: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/ReturnItemDraft' + returnDate: + type: "string" + format: "datetime" + StagedOrderAddShoppingListAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + shoppingList: + $ref: '#/components/schemas/ShoppingListResourceIdentifier' + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + StagedOrderChangeCustomLineItemMoneyAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + money: + $ref: '#/components/schemas/Money' + StagedOrderChangeCustomLineItemQuantityAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + quantity: + type: "number" + format: "double" + StagedOrderChangeLineItemQuantityAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "number" + format: "double" + externalPrice: + $ref: '#/components/schemas/Money' + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + StagedOrderChangeOrderStateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + orderState: + $ref: '#/components/schemas/OrderState' + StagedOrderChangePaymentStateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + paymentState: + $ref: '#/components/schemas/PaymentState' + StagedOrderChangeShipmentStateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + shipmentState: + $ref: '#/components/schemas/ShipmentState' + StagedOrderChangeTaxCalculationModeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxCalculationMode: + $ref: '#/components/schemas/TaxCalculationMode' + StagedOrderChangeTaxModeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxMode: + $ref: '#/components/schemas/TaxMode' + StagedOrderChangeTaxRoundingModeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxRoundingMode: + $ref: '#/components/schemas/RoundingMode' + StagedOrderImportCustomLineItemStateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + state: + type: "array" + items: + $ref: '#/components/schemas/ItemState' + StagedOrderImportLineItemStateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + state: + type: "array" + items: + $ref: '#/components/schemas/ItemState' + StagedOrderRemoveCustomLineItemAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + StagedOrderRemoveDeliveryAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + StagedOrderRemoveDiscountCodeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + discountCode: + $ref: '#/components/schemas/DiscountCodeReference' + StagedOrderRemoveItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressKey: + type: "string" + StagedOrderRemoveLineItemAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "number" + format: "double" + externalPrice: + $ref: '#/components/schemas/Money' + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + shippingDetailsToRemove: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + StagedOrderRemoveParcelFromDeliveryAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + StagedOrderRemovePaymentAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + payment: + $ref: '#/components/schemas/PaymentResourceIdentifier' + StagedOrderSetBillingAddressAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + StagedOrderSetBillingAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + StagedOrderSetBillingAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + StagedOrderSetCountryAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + country: + type: "string" + StagedOrderSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + StagedOrderSetCustomLineItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + StagedOrderSetCustomLineItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + StagedOrderSetCustomLineItemShippingDetailsAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + StagedOrderSetCustomLineItemTaxAmountAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + externalTaxAmount: + $ref: '#/components/schemas/ExternalTaxAmountDraft' + StagedOrderSetCustomLineItemTaxRateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + StagedOrderSetCustomShippingMethodAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + shippingMethodName: + type: "string" + shippingRate: + $ref: '#/components/schemas/ShippingRateDraft' + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + StagedOrderSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + StagedOrderSetCustomerEmailAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + email: + type: "string" + StagedOrderSetCustomerGroupAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customerGroup: + $ref: '#/components/schemas/CustomerGroupResourceIdentifier' + StagedOrderSetCustomerIdAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customerId: + type: "string" + StagedOrderSetDeliveryAddressAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + StagedOrderSetDeliveryAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + StagedOrderSetDeliveryAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + StagedOrderSetDeliveryCustomFieldAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + StagedOrderSetDeliveryCustomTypeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + type: "string" + additionalProperties: true + StagedOrderSetDeliveryItemsAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + StagedOrderSetItemShippingAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressKey: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + StagedOrderSetItemShippingAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressKey: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + StagedOrderSetLineItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + StagedOrderSetLineItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + StagedOrderSetLineItemDistributionChannelAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + StagedOrderSetLineItemPriceAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + externalPrice: + $ref: '#/components/schemas/Money' + StagedOrderSetLineItemShippingDetailsAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + StagedOrderSetLineItemTaxAmountAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + externalTaxAmount: + $ref: '#/components/schemas/ExternalTaxAmountDraft' + StagedOrderSetLineItemTaxRateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + StagedOrderSetLineItemTotalPriceAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + externalTotalPrice: + $ref: '#/components/schemas/ExternalLineItemTotalPrice' + StagedOrderSetLocaleAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + locale: + type: "string" + StagedOrderSetOrderNumberAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + orderNumber: + type: "string" + StagedOrderSetOrderTotalTaxAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + externalTotalGross: + $ref: '#/components/schemas/Money' + externalTaxPortions: + type: "array" + items: + $ref: '#/components/schemas/TaxPortionDraft' + StagedOrderSetParcelCustomFieldAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + StagedOrderSetParcelCustomTypeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + type: "string" + additionalProperties: true + StagedOrderSetParcelItemsAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + StagedOrderSetParcelMeasurementsAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + measurements: + $ref: '#/components/schemas/ParcelMeasurements' + StagedOrderSetParcelTrackingDataAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + trackingData: + $ref: '#/components/schemas/TrackingData' + StagedOrderSetReturnInfoAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/ReturnInfoDraft' + StagedOrderSetReturnItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + returnItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + StagedOrderSetReturnItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + returnItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + type: "string" + additionalProperties: true + StagedOrderSetReturnPaymentStateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + returnItemId: + type: "string" + paymentState: + $ref: '#/components/schemas/ReturnPaymentState' + StagedOrderSetReturnShipmentStateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + returnItemId: + type: "string" + shipmentState: + $ref: '#/components/schemas/ReturnShipmentState' + StagedOrderSetShippingAddressAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + StagedOrderSetShippingAddressAndCustomShippingMethodAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + shippingMethodName: + type: "string" + shippingRate: + $ref: '#/components/schemas/ShippingRateDraft' + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + StagedOrderSetShippingAddressAndShippingMethodAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + shippingMethod: + $ref: '#/components/schemas/ShippingMethodResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + StagedOrderSetShippingAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + StagedOrderSetShippingAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + StagedOrderSetShippingMethodAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + shippingMethod: + $ref: '#/components/schemas/ShippingMethodResourceIdentifier' + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + StagedOrderSetShippingMethodTaxAmountAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + externalTaxAmount: + $ref: '#/components/schemas/ExternalTaxAmountDraft' + StagedOrderSetShippingMethodTaxRateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + externalTaxRate: + $ref: '#/components/schemas/ExternalTaxRateDraft' + StagedOrderSetShippingRateInputAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + shippingRateInput: + $ref: '#/components/schemas/ShippingRateInputDraft' + StagedOrderTransitionCustomLineItemStateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + fromState: + $ref: '#/components/schemas/StateResourceIdentifier' + toState: + $ref: '#/components/schemas/StateResourceIdentifier' + actualTransitionDate: + type: "string" + format: "datetime" + StagedOrderTransitionLineItemStateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + fromState: + $ref: '#/components/schemas/StateResourceIdentifier' + toState: + $ref: '#/components/schemas/StateResourceIdentifier' + actualTransitionDate: + type: "string" + format: "datetime" + StagedOrderTransitionStateAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + state: + $ref: '#/components/schemas/StateResourceIdentifier' + force: + type: "boolean" + StagedOrderUpdateItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + StagedOrderUpdateSyncInfoAction: + allOf: + - $ref: '#/components/schemas/StagedOrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + channel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + externalId: + type: "string" + syncedAt: + type: "string" + format: "datetime" + Hit: + type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + relevance: + type: "number" + format: "double" + OrderPagedSearchResponse: + type: "object" + properties: + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + limit: + type: "integer" + format: "int64" + hits: + type: "array" + items: + $ref: '#/components/schemas/Hit' + CustomLineItemImportDraft: + type: "object" + properties: + name: + $ref: '#/components/schemas/LocalizedString' + quantity: + type: "integer" + format: "int64" + money: + $ref: '#/components/schemas/Money' + slug: + type: "string" + state: + type: "array" + items: + $ref: '#/components/schemas/ItemState' + taxRate: + $ref: '#/components/schemas/TaxRate' + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + CustomLineItemReturnItem: + allOf: + - $ref: '#/components/schemas/ReturnItem' + - type: "object" + properties: + id: + type: "string" + quantity: + type: "integer" + format: "int64" + type: + type: "string" + comment: + type: "string" + shipmentState: + $ref: '#/components/schemas/ReturnShipmentState' + paymentState: + $ref: '#/components/schemas/ReturnPaymentState' + custom: + $ref: '#/components/schemas/CustomFields' + lastModifiedAt: + type: "string" + format: "datetime" + createdAt: + type: "string" + format: "datetime" + customLineItemId: + type: "string" + Delivery: + type: "object" + properties: + id: + type: "string" + createdAt: + type: "string" + format: "datetime" + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + parcels: + type: "array" + items: + $ref: '#/components/schemas/Parcel' + address: + $ref: '#/components/schemas/Address' + custom: + $ref: '#/components/schemas/CustomFields' + DeliveryItem: + type: "object" + properties: + id: + type: "string" + quantity: + type: "integer" + format: "int64" + DiscountedLineItemPriceDraft: + type: "object" + properties: + value: + $ref: '#/components/schemas/Money' + includedDiscounts: + type: "array" + items: + $ref: '#/components/schemas/DiscountedLineItemPortion' + ItemState: + type: "object" + properties: + quantity: + type: "number" + format: "double" + state: + $ref: '#/components/schemas/StateReference' + LineItemImportDraft: + type: "object" + properties: + productId: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + variant: + $ref: '#/components/schemas/ProductVariantImportDraft' + price: + $ref: '#/components/schemas/PriceDraft' + quantity: + type: "integer" + format: "int64" + state: + type: "array" + items: + $ref: '#/components/schemas/ItemState' + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + taxRate: + $ref: '#/components/schemas/TaxRate' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + LineItemReturnItem: + allOf: + - $ref: '#/components/schemas/ReturnItem' + - type: "object" + properties: + id: + type: "string" + quantity: + type: "integer" + format: "int64" + type: + type: "string" + comment: + type: "string" + shipmentState: + $ref: '#/components/schemas/ReturnShipmentState' + paymentState: + $ref: '#/components/schemas/ReturnPaymentState' + custom: + $ref: '#/components/schemas/CustomFields' + lastModifiedAt: + type: "string" + format: "datetime" + createdAt: + type: "string" + format: "datetime" + lineItemId: + type: "string" + Order: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + completedAt: + type: "string" + format: "datetime" + orderNumber: + type: "string" + customerId: + type: "string" + customerEmail: + type: "string" + anonymousId: + type: "string" + store: + $ref: '#/components/schemas/StoreKeyReference' + lineItems: + type: "array" + items: + $ref: '#/components/schemas/LineItem' + customLineItems: + type: "array" + items: + $ref: '#/components/schemas/CustomLineItem' + totalPrice: + $ref: '#/components/schemas/TypedMoney' + taxedPrice: + $ref: '#/components/schemas/TaxedPrice' + shippingAddress: + $ref: '#/components/schemas/Address' + billingAddress: + $ref: '#/components/schemas/Address' + taxMode: + $ref: '#/components/schemas/TaxMode' + taxRoundingMode: + $ref: '#/components/schemas/RoundingMode' + customerGroup: + $ref: '#/components/schemas/CustomerGroupReference' + country: + type: "string" + orderState: + $ref: '#/components/schemas/OrderState' + state: + $ref: '#/components/schemas/StateReference' + shipmentState: + $ref: '#/components/schemas/ShipmentState' + paymentState: + $ref: '#/components/schemas/PaymentState' + shippingInfo: + $ref: '#/components/schemas/ShippingInfo' + syncInfo: + type: "array" + items: + $ref: '#/components/schemas/SyncInfo' + returnInfo: + type: "array" + items: + $ref: '#/components/schemas/ReturnInfo' + discountCodes: + type: "array" + items: + $ref: '#/components/schemas/DiscountCodeInfo' + lastMessageSequenceNumber: + type: "integer" + format: "int64" + cart: + $ref: '#/components/schemas/CartReference' + custom: + $ref: '#/components/schemas/CustomFields' + paymentInfo: + $ref: '#/components/schemas/PaymentInfo' + locale: + type: "string" + inventoryMode: + $ref: '#/components/schemas/InventoryMode' + origin: + $ref: '#/components/schemas/CartOrigin' + taxCalculationMode: + $ref: '#/components/schemas/TaxCalculationMode' + shippingRateInput: + $ref: '#/components/schemas/ShippingRateInput' + itemShippingAddresses: + type: "array" + items: + $ref: '#/components/schemas/Address' + refusedGifts: + type: "array" + items: + $ref: '#/components/schemas/CartDiscountReference' + OrderFromCartDraft: + type: "object" + properties: + id: + type: "string" + cart: + $ref: '#/components/schemas/CartResourceIdentifier' + version: + type: "integer" + format: "int64" + orderNumber: + type: "string" + paymentState: + $ref: '#/components/schemas/PaymentState' + shipmentState: + $ref: '#/components/schemas/ShipmentState' + orderState: + $ref: '#/components/schemas/OrderState' + state: + $ref: '#/components/schemas/StateResourceIdentifier' + OrderImportDraft: + type: "object" + properties: + orderNumber: + type: "string" + customerId: + type: "string" + customerEmail: + type: "string" + lineItems: + type: "array" + items: + $ref: '#/components/schemas/LineItemImportDraft' + customLineItems: + type: "array" + items: + $ref: '#/components/schemas/CustomLineItemImportDraft' + totalPrice: + $ref: '#/components/schemas/Money' + taxedPrice: + $ref: '#/components/schemas/TaxedPriceDraft' + shippingAddress: + $ref: '#/components/schemas/BaseAddress' + billingAddress: + $ref: '#/components/schemas/BaseAddress' + customerGroup: + $ref: '#/components/schemas/CustomerGroupResourceIdentifier' + country: + type: "string" + orderState: + $ref: '#/components/schemas/OrderState' + shipmentState: + $ref: '#/components/schemas/ShipmentState' + paymentState: + $ref: '#/components/schemas/PaymentState' + shippingInfo: + $ref: '#/components/schemas/ShippingInfoImportDraft' + completedAt: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + inventoryMode: + $ref: '#/components/schemas/InventoryMode' + taxRoundingMode: + $ref: '#/components/schemas/RoundingMode' + itemShippingAddresses: + type: "array" + items: + $ref: '#/components/schemas/BaseAddress' + store: + $ref: '#/components/schemas/StoreResourceIdentifier' + origin: + $ref: '#/components/schemas/CartOrigin' + OrderPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Order' + OrderReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/Order' + OrderResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + OrderSearchQuery: + type: "string" + OrderSearchRequest: + type: "object" + properties: + query: + $ref: '#/components/schemas/OrderSearchQuery' + sort: + $ref: '#/components/schemas/OrderSearchSorting' + limit: + type: "integer" + format: "int32" + offset: + type: "integer" + format: "int32" + OrderSearchSorting: + type: "string" + OrderState: + type: "string" + enum: + - Open + - Confirmed + - Complete + - Cancelled + x-annotation-package: "Order" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-orders.html#orderstate" + OrderUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/OrderUpdateAction' + OrderUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addDelivery: '#/components/schemas/OrderAddDeliveryAction' + addItemShippingAddress: '#/components/schemas/OrderAddItemShippingAddressAction' + addParcelToDelivery: '#/components/schemas/OrderAddParcelToDeliveryAction' + addPayment: '#/components/schemas/OrderAddPaymentAction' + addReturnInfo: '#/components/schemas/OrderAddReturnInfoAction' + changeOrderState: '#/components/schemas/OrderChangeOrderStateAction' + changePaymentState: '#/components/schemas/OrderChangePaymentStateAction' + changeShipmentState: '#/components/schemas/OrderChangeShipmentStateAction' + importCustomLineItemState: '#/components/schemas/OrderImportCustomLineItemStateAction' + importLineItemState: '#/components/schemas/OrderImportLineItemStateAction' + removeDelivery: '#/components/schemas/OrderRemoveDeliveryAction' + removeItemShippingAddress: '#/components/schemas/OrderRemoveItemShippingAddressAction' + removeParcelFromDelivery: '#/components/schemas/OrderRemoveParcelFromDeliveryAction' + removePayment: '#/components/schemas/OrderRemovePaymentAction' + setBillingAddress: '#/components/schemas/OrderSetBillingAddressAction' + setBillingAddressCustomField: '#/components/schemas/OrderSetBillingAddressCustomFieldAction' + setBillingAddressCustomType: '#/components/schemas/OrderSetBillingAddressCustomTypeAction' + setCustomField: '#/components/schemas/OrderSetCustomFieldAction' + setCustomLineItemCustomField: '#/components/schemas/OrderSetCustomLineItemCustomFieldAction' + setCustomLineItemCustomType: '#/components/schemas/OrderSetCustomLineItemCustomTypeAction' + setCustomLineItemShippingDetails: '#/components/schemas/OrderSetCustomLineItemShippingDetailsAction' + setCustomType: '#/components/schemas/OrderSetCustomTypeAction' + setCustomerEmail: '#/components/schemas/OrderSetCustomerEmailAction' + setCustomerId: '#/components/schemas/OrderSetCustomerIdAction' + setDeliveryAddress: '#/components/schemas/OrderSetDeliveryAddressAction' + setDeliveryAddressCustomField: '#/components/schemas/OrderSetDeliveryAddressCustomFieldAction' + setDeliveryAddressCustomType: '#/components/schemas/OrderSetDeliveryAddressCustomTypeAction' + setDeliveryCustomField: '#/components/schemas/OrderSetDeliveryCustomFieldAction' + setDeliveryCustomType: '#/components/schemas/OrderSetDeliveryCustomTypeAction' + setDeliveryItems: '#/components/schemas/OrderSetDeliveryItemsAction' + setItemShippingAddressCustomField: '#/components/schemas/OrderSetItemShippingAddressCustomFieldAction' + setItemShippingAddressCustomType: '#/components/schemas/OrderSetItemShippingAddressCustomTypeAction' + setLineItemCustomField: '#/components/schemas/OrderSetLineItemCustomFieldAction' + setLineItemCustomType: '#/components/schemas/OrderSetLineItemCustomTypeAction' + setLineItemShippingDetails: '#/components/schemas/OrderSetLineItemShippingDetailsAction' + setLocale: '#/components/schemas/OrderSetLocaleAction' + setOrderNumber: '#/components/schemas/OrderSetOrderNumberAction' + setParcelCustomField: '#/components/schemas/OrderSetParcelCustomFieldAction' + setParcelCustomType: '#/components/schemas/OrderSetParcelCustomTypeAction' + setParcelItems: '#/components/schemas/OrderSetParcelItemsAction' + setParcelMeasurements: '#/components/schemas/OrderSetParcelMeasurementsAction' + setParcelTrackingData: '#/components/schemas/OrderSetParcelTrackingDataAction' + setReturnInfo: '#/components/schemas/OrderSetReturnInfoAction' + setReturnItemCustomField: '#/components/schemas/OrderSetReturnItemCustomFieldAction' + setReturnItemCustomType: '#/components/schemas/OrderSetReturnItemCustomTypeAction' + setReturnPaymentState: '#/components/schemas/OrderSetReturnPaymentStateAction' + setReturnShipmentState: '#/components/schemas/OrderSetReturnShipmentStateAction' + setShippingAddress: '#/components/schemas/OrderSetShippingAddressAction' + setShippingAddressCustomField: '#/components/schemas/OrderSetShippingAddressCustomFieldAction' + setShippingAddressCustomType: '#/components/schemas/OrderSetShippingAddressCustomTypeAction' + setStore: '#/components/schemas/OrderSetStoreAction' + transitionCustomLineItemState: '#/components/schemas/OrderTransitionCustomLineItemStateAction' + transitionLineItemState: '#/components/schemas/OrderTransitionLineItemStateAction' + transitionState: '#/components/schemas/OrderTransitionStateAction' + updateItemShippingAddress: '#/components/schemas/OrderUpdateItemShippingAddressAction' + updateSyncInfo: '#/components/schemas/OrderUpdateSyncInfoAction' + properties: + action: + type: "string" + Parcel: + type: "object" + properties: + id: + type: "string" + createdAt: + type: "string" + format: "datetime" + measurements: + $ref: '#/components/schemas/ParcelMeasurements' + trackingData: + $ref: '#/components/schemas/TrackingData' + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + custom: + $ref: '#/components/schemas/CustomFields' + ParcelDraft: + type: "object" + properties: + measurements: + $ref: '#/components/schemas/ParcelMeasurements' + trackingData: + $ref: '#/components/schemas/TrackingData' + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + ParcelMeasurements: + type: "object" + properties: + heightInMillimeter: + type: "number" + format: "double" + lengthInMillimeter: + type: "number" + format: "double" + widthInMillimeter: + type: "number" + format: "double" + weightInGram: + type: "number" + format: "double" + PaymentInfo: + type: "object" + properties: + payments: + type: "array" + items: + $ref: '#/components/schemas/PaymentReference' + PaymentState: + type: "string" + enum: + - BalanceDue + - Failed + - Pending + - CreditOwed + - Paid + x-annotation-package: "Order" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-orders.html#paymentstate" + ProductVariantImportDraft: + type: "object" + properties: + id: + type: "integer" + format: "int64" + sku: + type: "string" + prices: + type: "array" + items: + $ref: '#/components/schemas/PriceDraft' + attributes: + type: "array" + items: + $ref: '#/components/schemas/Attribute' + images: + type: "array" + items: + $ref: '#/components/schemas/Image' + ReturnInfo: + type: "object" + properties: + items: + type: "array" + items: + $ref: '#/components/schemas/ReturnItem' + returnTrackingId: + type: "string" + returnDate: + type: "string" + format: "datetime" + ReturnInfoDraft: + type: "object" + properties: + items: + type: "array" + items: + $ref: '#/components/schemas/ReturnItemDraft' + returnTrackingId: + type: "string" + returnDate: + type: "string" + format: "datetime" + ReturnItem: + type: "object" + discriminator: + propertyName: type + mapping: + CustomLineItemReturnItem: '#/components/schemas/CustomLineItemReturnItem' + LineItemReturnItem: '#/components/schemas/LineItemReturnItem' + properties: + id: + type: "string" + quantity: + type: "integer" + format: "int64" + type: + type: "string" + comment: + type: "string" + shipmentState: + $ref: '#/components/schemas/ReturnShipmentState' + paymentState: + $ref: '#/components/schemas/ReturnPaymentState' + custom: + $ref: '#/components/schemas/CustomFields' + lastModifiedAt: + type: "string" + format: "datetime" + createdAt: + type: "string" + format: "datetime" + ReturnItemDraft: + type: "object" + properties: + quantity: + type: "integer" + format: "int64" + lineItemId: + type: "string" + customLineItemId: + type: "string" + comment: + type: "string" + shipmentState: + $ref: '#/components/schemas/ReturnShipmentState' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + ReturnPaymentState: + type: "string" + enum: + - NonRefundable + - Initial + - Refunded + - NotRefunded + x-annotation-package: "Order" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-orders.html#returnpaymentstate" + ReturnShipmentState: + type: "string" + enum: + - Advised + - Returned + - BackInStock + - Unusable + x-annotation-package: "Order" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-orders.html#returnshipmentstate" + ShipmentState: + type: "string" + enum: + - Shipped + - Ready + - Pending + - Delayed + - Partial + - Backorder + x-annotation-package: "Order" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-orders.html#shipmentstate" + ShippingInfoImportDraft: + type: "object" + properties: + shippingMethodName: + type: "string" + price: + $ref: '#/components/schemas/Money' + shippingRate: + $ref: '#/components/schemas/ShippingRateDraft' + taxRate: + $ref: '#/components/schemas/TaxRate' + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + shippingMethod: + $ref: '#/components/schemas/ShippingMethodResourceIdentifier' + deliveries: + type: "array" + items: + $ref: '#/components/schemas/Delivery' + discountedPrice: + $ref: '#/components/schemas/DiscountedLineItemPriceDraft' + shippingMethodState: + $ref: '#/components/schemas/ShippingMethodState' + SyncInfo: + type: "object" + properties: + channel: + $ref: '#/components/schemas/ChannelReference' + externalId: + type: "string" + syncedAt: + type: "string" + format: "datetime" + TaxedItemPriceDraft: + type: "object" + properties: + totalNet: + $ref: '#/components/schemas/Money' + totalGross: + $ref: '#/components/schemas/Money' + TrackingData: + type: "object" + properties: + trackingId: + type: "string" + carrier: + type: "string" + provider: + type: "string" + providerTransaction: + type: "string" + isReturn: + type: "boolean" + OrderAddDeliveryAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + address: + $ref: '#/components/schemas/BaseAddress' + parcels: + type: "array" + items: + $ref: '#/components/schemas/ParcelDraft' + custom: + $ref: '#/components/schemas/CustomFields' + OrderAddItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + OrderAddParcelToDeliveryAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + measurements: + $ref: '#/components/schemas/ParcelMeasurements' + trackingData: + $ref: '#/components/schemas/TrackingData' + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + OrderAddPaymentAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + payment: + $ref: '#/components/schemas/PaymentResourceIdentifier' + OrderAddReturnInfoAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + returnTrackingId: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/ReturnItemDraft' + returnDate: + type: "string" + format: "datetime" + OrderChangeOrderStateAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + orderState: + $ref: '#/components/schemas/OrderState' + OrderChangePaymentStateAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + paymentState: + $ref: '#/components/schemas/PaymentState' + OrderChangeShipmentStateAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + shipmentState: + $ref: '#/components/schemas/ShipmentState' + OrderImportCustomLineItemStateAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + state: + type: "array" + items: + $ref: '#/components/schemas/ItemState' + OrderImportLineItemStateAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + state: + type: "array" + items: + $ref: '#/components/schemas/ItemState' + OrderRemoveDeliveryAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + OrderRemoveItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressKey: + type: "string" + OrderRemoveParcelFromDeliveryAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + OrderRemovePaymentAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + payment: + $ref: '#/components/schemas/PaymentResourceIdentifier' + OrderSetBillingAddressAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + OrderSetBillingAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + OrderSetBillingAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + OrderSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + OrderSetCustomLineItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + OrderSetCustomLineItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + OrderSetCustomLineItemShippingDetailsAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + OrderSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + OrderSetCustomerEmailAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + email: + type: "string" + OrderSetCustomerIdAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customerId: + type: "string" + OrderSetDeliveryAddressAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + OrderSetDeliveryAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + OrderSetDeliveryAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + OrderSetDeliveryCustomFieldAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + OrderSetDeliveryCustomTypeAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + OrderSetDeliveryItemsAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + deliveryId: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + OrderSetItemShippingAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressKey: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + OrderSetItemShippingAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + addressKey: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + OrderSetLineItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + OrderSetLineItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + OrderSetLineItemShippingDetailsAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + shippingDetails: + $ref: '#/components/schemas/ItemShippingDetailsDraft' + OrderSetLocaleAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + locale: + type: "string" + OrderSetOrderNumberAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + orderNumber: + type: "string" + OrderSetParcelCustomFieldAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + OrderSetParcelCustomTypeAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + OrderSetParcelItemsAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/DeliveryItem' + OrderSetParcelMeasurementsAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + measurements: + $ref: '#/components/schemas/ParcelMeasurements' + OrderSetParcelTrackingDataAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + parcelId: + type: "string" + trackingData: + $ref: '#/components/schemas/TrackingData' + OrderSetReturnInfoAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + items: + type: "array" + items: + $ref: '#/components/schemas/ReturnInfoDraft' + OrderSetReturnItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + returnItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + OrderSetReturnItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + returnItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + OrderSetReturnPaymentStateAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + returnItemId: + type: "string" + paymentState: + $ref: '#/components/schemas/ReturnPaymentState' + OrderSetReturnShipmentStateAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + returnItemId: + type: "string" + shipmentState: + $ref: '#/components/schemas/ReturnShipmentState' + OrderSetShippingAddressAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + OrderSetShippingAddressCustomFieldAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + OrderSetShippingAddressCustomTypeAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + OrderSetStoreAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + store: + $ref: '#/components/schemas/StoreResourceIdentifier' + OrderTransitionCustomLineItemStateAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + customLineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + fromState: + $ref: '#/components/schemas/StateResourceIdentifier' + toState: + $ref: '#/components/schemas/StateResourceIdentifier' + actualTransitionDate: + type: "string" + format: "datetime" + OrderTransitionLineItemStateAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + fromState: + $ref: '#/components/schemas/StateResourceIdentifier' + toState: + $ref: '#/components/schemas/StateResourceIdentifier' + actualTransitionDate: + type: "string" + format: "datetime" + OrderTransitionStateAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + state: + $ref: '#/components/schemas/StateResourceIdentifier' + force: + type: "boolean" + OrderUpdateItemShippingAddressAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + address: + $ref: '#/components/schemas/BaseAddress' + OrderUpdateSyncInfoAction: + allOf: + - $ref: '#/components/schemas/OrderUpdateAction' + - type: "object" + properties: + action: + type: "string" + channel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + externalId: + type: "string" + syncedAt: + type: "string" + format: "datetime" + Payment: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + customer: + $ref: '#/components/schemas/CustomerReference' + anonymousId: + type: "string" + externalId: + type: "string" + interfaceId: + type: "string" + amountPlanned: + $ref: '#/components/schemas/TypedMoney' + amountAuthorized: + $ref: '#/components/schemas/TypedMoney' + authorizedUntil: + type: "string" + amountPaid: + $ref: '#/components/schemas/TypedMoney' + amountRefunded: + $ref: '#/components/schemas/TypedMoney' + paymentMethodInfo: + $ref: '#/components/schemas/PaymentMethodInfo' + paymentStatus: + $ref: '#/components/schemas/PaymentStatus' + transactions: + type: "array" + items: + $ref: '#/components/schemas/Transaction' + interfaceInteractions: + type: "array" + items: + $ref: '#/components/schemas/CustomFields' + custom: + $ref: '#/components/schemas/CustomFields' + key: + type: "string" + PaymentDraft: + type: "object" + properties: + customer: + $ref: '#/components/schemas/CustomerResourceIdentifier' + anonymousId: + type: "string" + externalId: + type: "string" + interfaceId: + type: "string" + amountPlanned: + $ref: '#/components/schemas/Money' + amountAuthorized: + $ref: '#/components/schemas/Money' + authorizedUntil: + type: "string" + amountPaid: + $ref: '#/components/schemas/Money' + amountRefunded: + $ref: '#/components/schemas/Money' + paymentMethodInfo: + $ref: '#/components/schemas/PaymentMethodInfo' + paymentStatus: + $ref: '#/components/schemas/PaymentStatusDraft' + transactions: + type: "array" + items: + $ref: '#/components/schemas/TransactionDraft' + interfaceInteractions: + type: "array" + items: + $ref: '#/components/schemas/CustomFieldsDraft' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + key: + type: "string" + PaymentMethodInfo: + type: "object" + properties: + paymentInterface: + type: "string" + method: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + PaymentPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Payment' + PaymentReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/Payment' + PaymentResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + PaymentStatus: + type: "object" + properties: + interfaceCode: + type: "string" + interfaceText: + type: "string" + state: + $ref: '#/components/schemas/StateReference' + PaymentStatusDraft: + type: "object" + properties: + interfaceCode: + type: "string" + interfaceText: + type: "string" + state: + $ref: '#/components/schemas/StateResourceIdentifier' + PaymentUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/PaymentUpdateAction' + PaymentUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addInterfaceInteraction: '#/components/schemas/PaymentAddInterfaceInteractionAction' + addTransaction: '#/components/schemas/PaymentAddTransactionAction' + changeAmountPlanned: '#/components/schemas/PaymentChangeAmountPlannedAction' + changeTransactionInteractionId: '#/components/schemas/PaymentChangeTransactionInteractionIdAction' + changeTransactionState: '#/components/schemas/PaymentChangeTransactionStateAction' + changeTransactionTimestamp: '#/components/schemas/PaymentChangeTransactionTimestampAction' + setAmountPaid: '#/components/schemas/PaymentSetAmountPaidAction' + setAmountRefunded: '#/components/schemas/PaymentSetAmountRefundedAction' + setAnonymousId: '#/components/schemas/PaymentSetAnonymousIdAction' + setAuthorization: '#/components/schemas/PaymentSetAuthorizationAction' + setCustomField: '#/components/schemas/PaymentSetCustomFieldAction' + setCustomType: '#/components/schemas/PaymentSetCustomTypeAction' + setCustomer: '#/components/schemas/PaymentSetCustomerAction' + setExternalId: '#/components/schemas/PaymentSetExternalIdAction' + setInterfaceId: '#/components/schemas/PaymentSetInterfaceIdAction' + setKey: '#/components/schemas/PaymentSetKeyAction' + setMethodInfoInterface: '#/components/schemas/PaymentSetMethodInfoInterfaceAction' + setMethodInfoMethod: '#/components/schemas/PaymentSetMethodInfoMethodAction' + setMethodInfoName: '#/components/schemas/PaymentSetMethodInfoNameAction' + setStatusInterfaceCode: '#/components/schemas/PaymentSetStatusInterfaceCodeAction' + setStatusInterfaceText: '#/components/schemas/PaymentSetStatusInterfaceTextAction' + setTransactionCustomField: '#/components/schemas/PaymentSetTransactionCustomFieldAction' + setTransactionCustomType: '#/components/schemas/PaymentSetTransactionCustomTypeAction' + transitionState: '#/components/schemas/PaymentTransitionStateAction' + properties: + action: + type: "string" + Transaction: + type: "object" + properties: + id: + type: "string" + timestamp: + type: "string" + format: "datetime" + type: + $ref: '#/components/schemas/TransactionType' + amount: + $ref: '#/components/schemas/TypedMoney' + interactionId: + type: "string" + state: + $ref: '#/components/schemas/TransactionState' + custom: + $ref: '#/components/schemas/CustomFields' + TransactionDraft: + type: "object" + properties: + timestamp: + type: "string" + format: "datetime" + type: + $ref: '#/components/schemas/TransactionType' + amount: + $ref: '#/components/schemas/Money' + interactionId: + type: "string" + state: + $ref: '#/components/schemas/TransactionState' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + TransactionState: + type: "string" + enum: + - Initial + - Pending + - Success + - Failure + x-annotation-package: "Payment" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-payments.html#transactionstate" + TransactionType: + type: "string" + enum: + - Authorization + - CancelAuthorization + - Charge + - Refund + - Chargeback + x-annotation-package: "Payment" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-payments.html#transactiontype" + PaymentAddInterfaceInteractionAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + PaymentAddTransactionAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + transaction: + $ref: '#/components/schemas/TransactionDraft' + PaymentChangeAmountPlannedAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + amount: + $ref: '#/components/schemas/Money' + PaymentChangeTransactionInteractionIdAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + transactionId: + type: "string" + interactionId: + type: "string" + PaymentChangeTransactionStateAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + transactionId: + type: "string" + state: + $ref: '#/components/schemas/TransactionState' + PaymentChangeTransactionTimestampAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + transactionId: + type: "string" + timestamp: + type: "string" + format: "datetime" + PaymentSetAmountPaidAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + amount: + $ref: '#/components/schemas/Money' + PaymentSetAmountRefundedAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + amount: + $ref: '#/components/schemas/Money' + PaymentSetAnonymousIdAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + anonymousId: + type: "string" + PaymentSetAuthorizationAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + amount: + $ref: '#/components/schemas/Money' + until: + type: "string" + format: "datetime" + PaymentSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + PaymentSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + PaymentSetCustomerAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + customer: + $ref: '#/components/schemas/CustomerResourceIdentifier' + PaymentSetExternalIdAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + externalId: + type: "string" + PaymentSetInterfaceIdAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + interfaceId: + type: "string" + PaymentSetKeyAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + PaymentSetMethodInfoInterfaceAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + interface: + type: "string" + PaymentSetMethodInfoMethodAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + method: + type: "string" + PaymentSetMethodInfoNameAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + PaymentSetStatusInterfaceCodeAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + interfaceCode: + type: "string" + PaymentSetStatusInterfaceTextAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + interfaceText: + type: "string" + PaymentSetTransactionCustomFieldAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + transactionId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + PaymentSetTransactionCustomTypeAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + transactionId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + PaymentTransitionStateAction: + allOf: + - $ref: '#/components/schemas/PaymentUpdateAction' + - type: "object" + properties: + action: + type: "string" + state: + $ref: '#/components/schemas/StateResourceIdentifier' + force: + type: "boolean" + ProductDiscount: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + name: + $ref: '#/components/schemas/LocalizedString' + key: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + value: + $ref: '#/components/schemas/ProductDiscountValue' + predicate: + type: "string" + sortOrder: + type: "string" + isActive: + type: "boolean" + references: + type: "array" + items: + $ref: '#/components/schemas/Reference' + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + ProductDiscountDraft: + type: "object" + properties: + name: + $ref: '#/components/schemas/LocalizedString' + key: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + value: + $ref: '#/components/schemas/ProductDiscountValueDraft' + predicate: + type: "string" + sortOrder: + type: "string" + isActive: + type: "boolean" + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + ProductDiscountMatchQuery: + type: "object" + properties: + productId: + type: "string" + variantId: + type: "integer" + format: "int32" + staged: + type: "boolean" + price: + $ref: '#/components/schemas/QueryPrice' + ProductDiscountPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/ProductDiscount' + ProductDiscountReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/ProductDiscount' + ProductDiscountResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + ProductDiscountUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/ProductDiscountUpdateAction' + ProductDiscountUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + changeIsActive: '#/components/schemas/ProductDiscountChangeIsActiveAction' + changeName: '#/components/schemas/ProductDiscountChangeNameAction' + changePredicate: '#/components/schemas/ProductDiscountChangePredicateAction' + changeSortOrder: '#/components/schemas/ProductDiscountChangeSortOrderAction' + changeValue: '#/components/schemas/ProductDiscountChangeValueAction' + setDescription: '#/components/schemas/ProductDiscountSetDescriptionAction' + setKey: '#/components/schemas/ProductDiscountSetKeyAction' + setValidFrom: '#/components/schemas/ProductDiscountSetValidFromAction' + setValidFromAndUntil: '#/components/schemas/ProductDiscountSetValidFromAndUntilAction' + setValidUntil: '#/components/schemas/ProductDiscountSetValidUntilAction' + properties: + action: + type: "string" + ProductDiscountValue: + type: "object" + discriminator: + propertyName: type + mapping: + absolute: '#/components/schemas/ProductDiscountValueAbsolute' + external: '#/components/schemas/ProductDiscountValueExternal' + relative: '#/components/schemas/ProductDiscountValueRelative' + properties: + type: + type: "string" + ProductDiscountValueAbsolute: + allOf: + - $ref: '#/components/schemas/ProductDiscountValue' + - type: "object" + properties: + type: + type: "string" + money: + type: "array" + items: + $ref: '#/components/schemas/TypedMoney' + ProductDiscountValueAbsoluteDraft: + allOf: + - $ref: '#/components/schemas/ProductDiscountValueDraft' + - type: "object" + properties: + type: + type: "string" + money: + type: "array" + items: + $ref: '#/components/schemas/Money' + ProductDiscountValueDraft: + type: "object" + discriminator: + propertyName: type + mapping: + absolute: '#/components/schemas/ProductDiscountValueAbsoluteDraft' + external: '#/components/schemas/ProductDiscountValueExternalDraft' + relative: '#/components/schemas/ProductDiscountValueRelativeDraft' + properties: + type: + type: "string" + ProductDiscountValueExternal: + allOf: + - $ref: '#/components/schemas/ProductDiscountValue' + - type: "object" + properties: + type: + type: "string" + ProductDiscountValueExternalDraft: + allOf: + - $ref: '#/components/schemas/ProductDiscountValueDraft' + - type: "object" + properties: + type: + type: "string" + ProductDiscountValueRelative: + allOf: + - $ref: '#/components/schemas/ProductDiscountValue' + - type: "object" + properties: + type: + type: "string" + permyriad: + type: "integer" + format: "int64" + ProductDiscountValueRelativeDraft: + allOf: + - $ref: '#/components/schemas/ProductDiscountValueDraft' + - type: "object" + properties: + type: + type: "string" + permyriad: + type: "integer" + format: "int64" + ProductDiscountChangeIsActiveAction: + allOf: + - $ref: '#/components/schemas/ProductDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + isActive: + type: "boolean" + ProductDiscountChangeNameAction: + allOf: + - $ref: '#/components/schemas/ProductDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + ProductDiscountChangePredicateAction: + allOf: + - $ref: '#/components/schemas/ProductDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + predicate: + type: "string" + ProductDiscountChangeSortOrderAction: + allOf: + - $ref: '#/components/schemas/ProductDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + sortOrder: + type: "string" + ProductDiscountChangeValueAction: + allOf: + - $ref: '#/components/schemas/ProductDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + value: + $ref: '#/components/schemas/ProductDiscountValueDraft' + ProductDiscountSetDescriptionAction: + allOf: + - $ref: '#/components/schemas/ProductDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + ProductDiscountSetKeyAction: + allOf: + - $ref: '#/components/schemas/ProductDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + ProductDiscountSetValidFromAction: + allOf: + - $ref: '#/components/schemas/ProductDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + validFrom: + type: "string" + format: "datetime" + ProductDiscountSetValidFromAndUntilAction: + allOf: + - $ref: '#/components/schemas/ProductDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + validFrom: + type: "string" + format: "datetime" + validUntil: + type: "string" + format: "datetime" + ProductDiscountSetValidUntilAction: + allOf: + - $ref: '#/components/schemas/ProductDiscountUpdateAction' + - type: "object" + properties: + action: + type: "string" + validUntil: + type: "string" + format: "datetime" + AssignedProductReference: + type: "object" + properties: + product: + $ref: '#/components/schemas/ProductReference' + IndividualProductSelectionType: + allOf: + - $ref: '#/components/schemas/ProductSelectionType' + - type: "object" + properties: + type: + $ref: '#/components/schemas/ProductSelectionTypeEnum' + name: + $ref: '#/components/schemas/LocalizedString' + ProductSelection: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + productCount: + type: "integer" + format: "int32" + type: + $ref: '#/components/schemas/ProductSelectionTypeEnum' + ProductSelectionAssignment: + type: "object" + properties: + product: + $ref: '#/components/schemas/ProductReference' + productSelection: + $ref: '#/components/schemas/ProductSelectionReference' + ProductSelectionDraft: + type: "object" + properties: + key: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + ProductSelectionPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/ProductSelection' + ProductSelectionProductPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/AssignedProductReference' + ProductSelectionReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/ProductSelection' + ProductSelectionResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + ProductSelectionType: + type: "object" + discriminator: + propertyName: type + mapping: + individual: '#/components/schemas/IndividualProductSelectionType' + properties: + type: + $ref: '#/components/schemas/ProductSelectionTypeEnum' + ProductSelectionTypeEnum: + type: "string" + enum: + - individual + x-annotation-package: "ProductSelection" + x-annotation-docs-uri: --- "" + x-annotation-enumDescriptions: + individual: "For this type of Product Selections the Products are to be assigned individually + by using the [Add Product](/projects/product-selections#add-product) update action.n" + ProductSelectionUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionUpdateAction' + ProductSelectionUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addProduct: '#/components/schemas/ProductSelectionAddProductAction' + changeName: '#/components/schemas/ProductSelectionChangeNameAction' + removeProduct: '#/components/schemas/ProductSelectionRemoveProductAction' + setKey: '#/components/schemas/ProductSelectionSetKeyAction' + properties: + action: + type: "string" + ProductsInStorePagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionAssignment' + ProductSelectionAddProductAction: + allOf: + - $ref: '#/components/schemas/ProductSelectionUpdateAction' + - type: "object" + properties: + action: + type: "string" + product: + $ref: '#/components/schemas/ProductResourceIdentifier' + ProductSelectionChangeNameAction: + allOf: + - $ref: '#/components/schemas/ProductSelectionUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + ProductSelectionRemoveProductAction: + allOf: + - $ref: '#/components/schemas/ProductSelectionUpdateAction' + - type: "object" + properties: + action: + type: "string" + product: + $ref: '#/components/schemas/ProductResourceIdentifier' + ProductSelectionSetKeyAction: + allOf: + - $ref: '#/components/schemas/ProductSelectionUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + AttributeBooleanType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + AttributeConstraintEnum: + type: "string" + enum: + - None + - Unique + - CombinationUnique + - SameForAll + x-annotation-package: "ProductType" + AttributeConstraintEnumDraft: + type: "string" + enum: + - None + x-annotation-package: "ProductType" + AttributeDateTimeType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + AttributeDateType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + AttributeDefinition: + type: "object" + properties: + type: + $ref: '#/components/schemas/AttributeType' + name: + type: "string" + label: + $ref: '#/components/schemas/LocalizedString' + isRequired: + type: "boolean" + attributeConstraint: + $ref: '#/components/schemas/AttributeConstraintEnum' + inputTip: + $ref: '#/components/schemas/LocalizedString' + inputHint: + $ref: '#/components/schemas/TextInputHint' + isSearchable: + type: "boolean" + AttributeDefinitionDraft: + type: "object" + properties: + type: + $ref: '#/components/schemas/AttributeType' + name: + type: "string" + label: + $ref: '#/components/schemas/LocalizedString' + isRequired: + type: "boolean" + attributeConstraint: + $ref: '#/components/schemas/AttributeConstraintEnum' + inputTip: + $ref: '#/components/schemas/LocalizedString' + inputHint: + $ref: '#/components/schemas/TextInputHint' + isSearchable: + type: "boolean" + AttributeEnumType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + values: + type: "array" + items: + $ref: '#/components/schemas/AttributePlainEnumValue' + AttributeLocalizableTextType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + AttributeLocalizedEnumType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + values: + type: "array" + items: + $ref: '#/components/schemas/AttributeLocalizedEnumValue' + AttributeLocalizedEnumValue: + type: "object" + properties: + key: + type: "string" + label: + $ref: '#/components/schemas/LocalizedString' + AttributeMoneyType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + AttributeNestedType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + typeReference: + $ref: '#/components/schemas/ProductTypeReference' + AttributeNumberType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + AttributePlainEnumValue: + type: "object" + properties: + key: + type: "string" + label: + type: "string" + AttributeReferenceType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + referenceTypeId: + $ref: '#/components/schemas/ReferenceTypeId' + AttributeSetType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + elementType: + $ref: '#/components/schemas/AttributeType' + AttributeTextType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + AttributeTimeType: + allOf: + - $ref: '#/components/schemas/AttributeType' + - type: "object" + properties: + name: + type: "string" + AttributeType: + type: "object" + discriminator: + propertyName: name + mapping: + boolean: '#/components/schemas/AttributeBooleanType' + datetime: '#/components/schemas/AttributeDateTimeType' + date: '#/components/schemas/AttributeDateType' + enum: '#/components/schemas/AttributeEnumType' + ltext: '#/components/schemas/AttributeLocalizableTextType' + lenum: '#/components/schemas/AttributeLocalizedEnumType' + money: '#/components/schemas/AttributeMoneyType' + nested: '#/components/schemas/AttributeNestedType' + number: '#/components/schemas/AttributeNumberType' + reference: '#/components/schemas/AttributeReferenceType' + set: '#/components/schemas/AttributeSetType' + text: '#/components/schemas/AttributeTextType' + time: '#/components/schemas/AttributeTimeType' + properties: + name: + type: "string" + ProductType: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + name: + type: "string" + description: + type: "string" + attributes: + type: "array" + items: + $ref: '#/components/schemas/AttributeDefinition' + ProductTypeDraft: + type: "object" + properties: + key: + type: "string" + name: + type: "string" + description: + type: "string" + attributes: + type: "array" + items: + $ref: '#/components/schemas/AttributeDefinitionDraft' + ProductTypePagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/ProductType' + ProductTypeReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/ProductType' + ProductTypeResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + ProductTypeUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/ProductTypeUpdateAction' + ProductTypeUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addAttributeDefinition: '#/components/schemas/ProductTypeAddAttributeDefinitionAction' + addLocalizedEnumValue: '#/components/schemas/ProductTypeAddLocalizedEnumValueAction' + addPlainEnumValue: '#/components/schemas/ProductTypeAddPlainEnumValueAction' + changeAttributeConstraint: '#/components/schemas/ProductTypeChangeAttributeConstraintAction' + changeAttributeName: '#/components/schemas/ProductTypeChangeAttributeNameAction' + changeAttributeOrder: '#/components/schemas/ProductTypeChangeAttributeOrderAction' + changeAttributeOrderByName: '#/components/schemas/ProductTypeChangeAttributeOrderByNameAction' + changeDescription: '#/components/schemas/ProductTypeChangeDescriptionAction' + changeEnumKey: '#/components/schemas/ProductTypeChangeEnumKeyAction' + changeInputHint: '#/components/schemas/ProductTypeChangeInputHintAction' + changeIsSearchable: '#/components/schemas/ProductTypeChangeIsSearchableAction' + changeLabel: '#/components/schemas/ProductTypeChangeLabelAction' + changeLocalizedEnumValueLabel: '#/components/schemas/ProductTypeChangeLocalizedEnumValueLabelAction' + changeLocalizedEnumValueOrder: '#/components/schemas/ProductTypeChangeLocalizedEnumValueOrderAction' + changeName: '#/components/schemas/ProductTypeChangeNameAction' + changePlainEnumValueLabel: '#/components/schemas/ProductTypeChangePlainEnumValueLabelAction' + changePlainEnumValueOrder: '#/components/schemas/ProductTypeChangePlainEnumValueOrderAction' + removeAttributeDefinition: '#/components/schemas/ProductTypeRemoveAttributeDefinitionAction' + removeEnumValues: '#/components/schemas/ProductTypeRemoveEnumValuesAction' + setInputTip: '#/components/schemas/ProductTypeSetInputTipAction' + setKey: '#/components/schemas/ProductTypeSetKeyAction' + properties: + action: + type: "string" + TextInputHint: + type: "string" + enum: + - SingleLine + - MultiLine + x-annotation-package: "ProductType" + ProductTypeAddAttributeDefinitionAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attribute: + $ref: '#/components/schemas/AttributeDefinitionDraft' + ProductTypeAddLocalizedEnumValueAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + value: + $ref: '#/components/schemas/AttributeLocalizedEnumValue' + ProductTypeAddPlainEnumValueAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + value: + $ref: '#/components/schemas/AttributePlainEnumValue' + ProductTypeChangeAttributeConstraintAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + newValue: + $ref: '#/components/schemas/AttributeConstraintEnumDraft' + ProductTypeChangeAttributeNameAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + newAttributeName: + type: "string" + ProductTypeChangeAttributeOrderAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributes: + type: "array" + items: + $ref: '#/components/schemas/AttributeDefinition' + ProductTypeChangeAttributeOrderByNameAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeNames: + type: "array" + items: + type: "string" + ProductTypeChangeDescriptionAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + type: "string" + ProductTypeChangeEnumKeyAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + key: + type: "string" + newKey: + type: "string" + ProductTypeChangeInputHintAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + newValue: + $ref: '#/components/schemas/TextInputHint' + ProductTypeChangeIsSearchableAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + isSearchable: + type: "boolean" + ProductTypeChangeLabelAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + label: + $ref: '#/components/schemas/LocalizedString' + ProductTypeChangeLocalizedEnumValueLabelAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + newValue: + $ref: '#/components/schemas/AttributeLocalizedEnumValue' + ProductTypeChangeLocalizedEnumValueOrderAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + values: + type: "array" + items: + $ref: '#/components/schemas/AttributeLocalizedEnumValue' + ProductTypeChangeNameAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + ProductTypeChangePlainEnumValueLabelAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + newValue: + $ref: '#/components/schemas/AttributePlainEnumValue' + ProductTypeChangePlainEnumValueOrderAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + values: + type: "array" + items: + $ref: '#/components/schemas/AttributePlainEnumValue' + ProductTypeRemoveAttributeDefinitionAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + ProductTypeRemoveEnumValuesAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + keys: + type: "array" + items: + type: "string" + ProductTypeSetInputTipAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + attributeName: + type: "string" + inputTip: + $ref: '#/components/schemas/LocalizedString' + ProductTypeSetKeyAction: + allOf: + - $ref: '#/components/schemas/ProductTypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + Attribute: + type: "object" + properties: + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + AttributeValue: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + CategoryOrderHints: + type: "object" + additionalProperties: + type: "string" + CustomTokenizer: + allOf: + - $ref: '#/components/schemas/SuggestTokenizer' + - type: "object" + properties: + type: + type: "string" + inputs: + type: "array" + items: + type: "string" + FacetResult: + type: "object" + discriminator: + propertyName: type + mapping: + filter: '#/components/schemas/FilteredFacetResult' + range: '#/components/schemas/RangeFacetResult' + terms: '#/components/schemas/TermFacetResult' + properties: + type: + $ref: '#/components/schemas/FacetTypes' + FacetResultRange: + type: "object" + properties: + from: + type: "number" + format: "double" + fromStr: + type: "string" + to: + type: "number" + format: "double" + toStr: + type: "string" + count: + type: "integer" + format: "int64" + productCount: + type: "integer" + format: "int64" + total: + type: "number" + format: "double" + min: + type: "number" + format: "double" + max: + type: "number" + format: "double" + mean: + type: "number" + format: "double" + FacetResultTerm: + type: "object" + properties: + term: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + count: + type: "integer" + format: "int64" + productCount: + type: "integer" + format: "int64" + FacetResults: + type: "object" + additionalProperties: + type: "string" + FacetTypes: + type: "string" + enum: + - terms + - range + - filter + x-annotation-package: "Product" + FilteredFacetResult: + allOf: + - $ref: '#/components/schemas/FacetResult' + - type: "object" + properties: + type: + $ref: '#/components/schemas/FacetTypes' + count: + type: "integer" + format: "int64" + productCount: + type: "integer" + format: "int64" + Product: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + productType: + $ref: '#/components/schemas/ProductTypeReference' + masterData: + $ref: '#/components/schemas/ProductCatalogData' + taxCategory: + $ref: '#/components/schemas/TaxCategoryReference' + state: + $ref: '#/components/schemas/StateReference' + reviewRatingStatistics: + $ref: '#/components/schemas/ReviewRatingStatistics' + ProductCatalogData: + type: "object" + properties: + published: + type: "boolean" + current: + $ref: '#/components/schemas/ProductData' + staged: + $ref: '#/components/schemas/ProductData' + hasStagedChanges: + type: "boolean" + ProductData: + type: "object" + properties: + name: + $ref: '#/components/schemas/LocalizedString' + categories: + type: "array" + items: + $ref: '#/components/schemas/CategoryReference' + categoryOrderHints: + $ref: '#/components/schemas/CategoryOrderHints' + description: + $ref: '#/components/schemas/LocalizedString' + slug: + $ref: '#/components/schemas/LocalizedString' + metaTitle: + $ref: '#/components/schemas/LocalizedString' + metaDescription: + $ref: '#/components/schemas/LocalizedString' + metaKeywords: + $ref: '#/components/schemas/LocalizedString' + masterVariant: + $ref: '#/components/schemas/ProductVariant' + variants: + type: "array" + items: + $ref: '#/components/schemas/ProductVariant' + searchKeywords: + $ref: '#/components/schemas/SearchKeywords' + ProductDraft: + type: "object" + properties: + productType: + $ref: '#/components/schemas/ProductTypeResourceIdentifier' + name: + $ref: '#/components/schemas/LocalizedString' + slug: + $ref: '#/components/schemas/LocalizedString' + key: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + categories: + type: "array" + items: + $ref: '#/components/schemas/CategoryResourceIdentifier' + categoryOrderHints: + $ref: '#/components/schemas/CategoryOrderHints' + metaTitle: + $ref: '#/components/schemas/LocalizedString' + metaDescription: + $ref: '#/components/schemas/LocalizedString' + metaKeywords: + $ref: '#/components/schemas/LocalizedString' + masterVariant: + $ref: '#/components/schemas/ProductVariantDraft' + variants: + type: "array" + items: + $ref: '#/components/schemas/ProductVariantDraft' + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + searchKeywords: + $ref: '#/components/schemas/SearchKeywords' + state: + $ref: '#/components/schemas/StateResourceIdentifier' + publish: + type: "boolean" + ProductPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Product' + ProductProjection: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + key: + type: "string" + productType: + $ref: '#/components/schemas/ProductTypeReference' + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + slug: + $ref: '#/components/schemas/LocalizedString' + categories: + type: "array" + items: + $ref: '#/components/schemas/CategoryReference' + categoryOrderHints: + $ref: '#/components/schemas/CategoryOrderHints' + metaTitle: + $ref: '#/components/schemas/LocalizedString' + metaDescription: + $ref: '#/components/schemas/LocalizedString' + metaKeywords: + $ref: '#/components/schemas/LocalizedString' + searchKeywords: + $ref: '#/components/schemas/SearchKeywords' + hasStagedChanges: + type: "boolean" + published: + type: "boolean" + masterVariant: + $ref: '#/components/schemas/ProductVariant' + variants: + type: "array" + items: + $ref: '#/components/schemas/ProductVariant' + taxCategory: + $ref: '#/components/schemas/TaxCategoryReference' + state: + $ref: '#/components/schemas/StateReference' + reviewRatingStatistics: + $ref: '#/components/schemas/ReviewRatingStatistics' + ProductProjectionPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/ProductProjection' + ProductProjectionPagedSearchResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/ProductProjection' + facets: + $ref: '#/components/schemas/FacetResults' + ProductPublishScope: + type: "string" + enum: + - All + - Prices + x-annotation-package: "Cart" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-carts.html#cartorigin" + ProductReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/Product' + ProductResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + ProductUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/ProductUpdateAction' + ProductUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addAsset: '#/components/schemas/ProductAddAssetAction' + addExternalImage: '#/components/schemas/ProductAddExternalImageAction' + addPrice: '#/components/schemas/ProductAddPriceAction' + addToCategory: '#/components/schemas/ProductAddToCategoryAction' + addVariant: '#/components/schemas/ProductAddVariantAction' + changeAssetName: '#/components/schemas/ProductChangeAssetNameAction' + changeAssetOrder: '#/components/schemas/ProductChangeAssetOrderAction' + changeMasterVariant: '#/components/schemas/ProductChangeMasterVariantAction' + changeName: '#/components/schemas/ProductChangeNameAction' + changePrice: '#/components/schemas/ProductChangePriceAction' + changeSlug: '#/components/schemas/ProductChangeSlugAction' + legacySetSku: '#/components/schemas/ProductLegacySetSkuAction' + moveImageToPosition: '#/components/schemas/ProductMoveImageToPositionAction' + publish: '#/components/schemas/ProductPublishAction' + removeAsset: '#/components/schemas/ProductRemoveAssetAction' + removeFromCategory: '#/components/schemas/ProductRemoveFromCategoryAction' + removeImage: '#/components/schemas/ProductRemoveImageAction' + removePrice: '#/components/schemas/ProductRemovePriceAction' + removeVariant: '#/components/schemas/ProductRemoveVariantAction' + revertStagedChanges: '#/components/schemas/ProductRevertStagedChangesAction' + revertStagedVariantChanges: '#/components/schemas/ProductRevertStagedVariantChangesAction' + setAssetCustomField: '#/components/schemas/ProductSetAssetCustomFieldAction' + setAssetCustomType: '#/components/schemas/ProductSetAssetCustomTypeAction' + setAssetDescription: '#/components/schemas/ProductSetAssetDescriptionAction' + setAssetKey: '#/components/schemas/ProductSetAssetKeyAction' + setAssetSources: '#/components/schemas/ProductSetAssetSourcesAction' + setAssetTags: '#/components/schemas/ProductSetAssetTagsAction' + setAttribute: '#/components/schemas/ProductSetAttributeAction' + setAttributeInAllVariants: '#/components/schemas/ProductSetAttributeInAllVariantsAction' + setCategoryOrderHint: '#/components/schemas/ProductSetCategoryOrderHintAction' + setDescription: '#/components/schemas/ProductSetDescriptionAction' + setDiscountedPrice: '#/components/schemas/ProductSetDiscountedPriceAction' + setImageLabel: '#/components/schemas/ProductSetImageLabelAction' + setKey: '#/components/schemas/ProductSetKeyAction' + setMetaDescription: '#/components/schemas/ProductSetMetaDescriptionAction' + setMetaKeywords: '#/components/schemas/ProductSetMetaKeywordsAction' + setMetaTitle: '#/components/schemas/ProductSetMetaTitleAction' + setPrices: '#/components/schemas/ProductSetPricesAction' + setProductPriceCustomField: '#/components/schemas/ProductSetProductPriceCustomFieldAction' + setProductPriceCustomType: '#/components/schemas/ProductSetProductPriceCustomTypeAction' + setProductVariantKey: '#/components/schemas/ProductSetProductVariantKeyAction' + setSearchKeywords: '#/components/schemas/ProductSetSearchKeywordsAction' + setSku: '#/components/schemas/ProductSetSkuAction' + setTaxCategory: '#/components/schemas/ProductSetTaxCategoryAction' + transitionState: '#/components/schemas/ProductTransitionStateAction' + unpublish: '#/components/schemas/ProductUnpublishAction' + properties: + action: + type: "string" + ProductVariant: + type: "object" + properties: + id: + type: "integer" + format: "int64" + sku: + type: "string" + key: + type: "string" + prices: + type: "array" + items: + $ref: '#/components/schemas/Price' + attributes: + type: "array" + items: + $ref: '#/components/schemas/Attribute' + price: + $ref: '#/components/schemas/Price' + images: + type: "array" + items: + $ref: '#/components/schemas/Image' + assets: + type: "array" + items: + $ref: '#/components/schemas/Asset' + availability: + $ref: '#/components/schemas/ProductVariantAvailability' + isMatchingVariant: + type: "boolean" + scopedPrice: + $ref: '#/components/schemas/ScopedPrice' + scopedPriceDiscounted: + type: "boolean" + ProductVariantAvailability: + type: "object" + properties: + isOnStock: + type: "boolean" + restockableInDays: + type: "integer" + format: "int64" + availableQuantity: + type: "integer" + format: "int64" + channels: + $ref: '#/components/schemas/ProductVariantChannelAvailabilityMap' + ProductVariantChannelAvailability: + type: "object" + properties: + isOnStock: + type: "boolean" + restockableInDays: + type: "integer" + format: "int64" + availableQuantity: + type: "integer" + format: "int64" + ProductVariantChannelAvailabilityMap: + type: "object" + additionalProperties: + type: "string" + ProductVariantDraft: + type: "object" + properties: + sku: + type: "string" + key: + type: "string" + prices: + type: "array" + items: + $ref: '#/components/schemas/PriceDraft' + attributes: + type: "array" + items: + $ref: '#/components/schemas/Attribute' + images: + type: "array" + items: + $ref: '#/components/schemas/Image' + assets: + type: "array" + items: + $ref: '#/components/schemas/AssetDraft' + RangeFacetResult: + allOf: + - $ref: '#/components/schemas/FacetResult' + - type: "object" + properties: + type: + $ref: '#/components/schemas/FacetTypes' + ranges: + type: "array" + items: + $ref: '#/components/schemas/FacetResultRange' + SearchKeyword: + type: "object" + properties: + text: + type: "string" + suggestTokenizer: + $ref: '#/components/schemas/SuggestTokenizer' + SearchKeywords: + type: "object" + additionalProperties: + type: "string" + SuggestTokenizer: + type: "object" + discriminator: + propertyName: type + mapping: + custom: '#/components/schemas/CustomTokenizer' + whitespace: '#/components/schemas/WhitespaceTokenizer' + properties: + type: + type: "string" + Suggestion: + type: "object" + properties: + text: + type: "string" + SuggestionResult: + type: "object" + additionalProperties: + type: "string" + TermFacetResult: + allOf: + - $ref: '#/components/schemas/FacetResult' + - type: "object" + properties: + type: + $ref: '#/components/schemas/FacetTypes' + dataType: + $ref: '#/components/schemas/TermFacetResultType' + missing: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + other: + type: "integer" + format: "int64" + terms: + type: "array" + items: + $ref: '#/components/schemas/FacetResultTerm' + TermFacetResultType: + type: "string" + enum: + - text + - date + - time + - datetime + - boolean + - number + x-annotation-package: "Product" + WhitespaceTokenizer: + allOf: + - $ref: '#/components/schemas/SuggestTokenizer' + - type: "object" + properties: + type: + type: "string" + ProductAddAssetAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + asset: + $ref: '#/components/schemas/AssetDraft' + position: + type: "integer" + format: "int32" + ProductAddExternalImageAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + image: + $ref: '#/components/schemas/Image' + staged: + type: "boolean" + ProductAddPriceAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + price: + $ref: '#/components/schemas/PriceDraft' + staged: + type: "boolean" + ProductAddToCategoryAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + category: + $ref: '#/components/schemas/CategoryResourceIdentifier' + orderHint: + type: "string" + staged: + type: "boolean" + ProductAddVariantAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + sku: + type: "string" + key: + type: "string" + prices: + type: "array" + items: + $ref: '#/components/schemas/PriceDraft' + images: + type: "array" + items: + $ref: '#/components/schemas/Image' + attributes: + type: "array" + items: + $ref: '#/components/schemas/Attribute' + staged: + type: "boolean" + assets: + type: "array" + items: + $ref: '#/components/schemas/Asset' + ProductChangeAssetNameAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + assetId: + type: "string" + assetKey: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + ProductChangeAssetOrderAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + assetOrder: + type: "array" + items: + type: "string" + ProductChangeMasterVariantAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + ProductChangeNameAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + staged: + type: "boolean" + ProductChangePriceAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + priceId: + type: "string" + price: + $ref: '#/components/schemas/PriceDraft' + staged: + type: "boolean" + ProductChangeSlugAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + slug: + $ref: '#/components/schemas/LocalizedString' + staged: + type: "boolean" + ProductLegacySetSkuAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + sku: + type: "string" + variantId: + type: "integer" + format: "int32" + ProductMoveImageToPositionAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + imageUrl: + type: "string" + position: + type: "integer" + format: "int64" + staged: + type: "boolean" + ProductPublishAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + scope: + $ref: '#/components/schemas/ProductPublishScope' + ProductRemoveAssetAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + assetId: + type: "string" + assetKey: + type: "string" + ProductRemoveFromCategoryAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + category: + $ref: '#/components/schemas/CategoryResourceIdentifier' + staged: + type: "boolean" + ProductRemoveImageAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + imageUrl: + type: "string" + staged: + type: "boolean" + ProductRemovePriceAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + priceId: + type: "string" + staged: + type: "boolean" + ProductRemoveVariantAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + id: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + ProductRevertStagedChangesAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + ProductRevertStagedVariantChangesAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + ProductSetAssetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + assetId: + type: "string" + assetKey: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + ProductSetAssetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + assetId: + type: "string" + assetKey: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + type: "string" + additionalProperties: true + ProductSetAssetDescriptionAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + assetId: + type: "string" + assetKey: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + ProductSetAssetKeyAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + assetId: + type: "string" + assetKey: + type: "string" + ProductSetAssetSourcesAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + assetId: + type: "string" + assetKey: + type: "string" + sources: + type: "array" + items: + $ref: '#/components/schemas/AssetSource' + ProductSetAssetTagsAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + assetId: + type: "string" + assetKey: + type: "string" + tags: + type: "array" + items: + type: "string" + ProductSetAttributeAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + staged: + type: "boolean" + ProductSetAttributeInAllVariantsAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + staged: + type: "boolean" + ProductSetCategoryOrderHintAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + categoryId: + type: "string" + orderHint: + type: "string" + staged: + type: "boolean" + ProductSetDescriptionAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + staged: + type: "boolean" + ProductSetDiscountedPriceAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + priceId: + type: "string" + staged: + type: "boolean" + discounted: + $ref: '#/components/schemas/DiscountedPriceDraft' + ProductSetImageLabelAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + sku: + type: "string" + variantId: + type: "integer" + format: "int64" + imageUrl: + type: "string" + label: + type: "string" + staged: + type: "boolean" + ProductSetKeyAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + ProductSetMetaDescriptionAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + metaDescription: + $ref: '#/components/schemas/LocalizedString' + staged: + type: "boolean" + ProductSetMetaKeywordsAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + metaKeywords: + $ref: '#/components/schemas/LocalizedString' + staged: + type: "boolean" + ProductSetMetaTitleAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + metaTitle: + $ref: '#/components/schemas/LocalizedString' + staged: + type: "boolean" + ProductSetPricesAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + prices: + type: "array" + items: + $ref: '#/components/schemas/PriceDraft' + staged: + type: "boolean" + ProductSetProductPriceCustomFieldAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + priceId: + type: "string" + staged: + type: "boolean" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + ProductSetProductPriceCustomTypeAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + priceId: + type: "string" + staged: + type: "boolean" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + ProductSetProductVariantKeyAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + key: + type: "string" + staged: + type: "boolean" + ProductSetSearchKeywordsAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + searchKeywords: + $ref: '#/components/schemas/SearchKeywords' + staged: + type: "boolean" + ProductSetSkuAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + variantId: + type: "integer" + format: "int64" + sku: + type: "string" + staged: + type: "boolean" + ProductSetTaxCategoryAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + ProductTransitionStateAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + state: + $ref: '#/components/schemas/StateResourceIdentifier' + force: + type: "boolean" + ProductUnpublishAction: + allOf: + - $ref: '#/components/schemas/ProductUpdateAction' + - type: "object" + properties: + action: + type: "string" + CartClassificationType: + allOf: + - $ref: '#/components/schemas/ShippingRateInputType' + - type: "object" + properties: + type: + $ref: '#/components/schemas/ShippingRateTierType' + values: + type: "array" + items: + $ref: '#/components/schemas/CustomFieldLocalizedEnumValue' + CartScoreType: + allOf: + - $ref: '#/components/schemas/ShippingRateInputType' + - type: "object" + properties: + type: + $ref: '#/components/schemas/ShippingRateTierType' + CartValueType: + allOf: + - $ref: '#/components/schemas/ShippingRateInputType' + - type: "object" + properties: + type: + $ref: '#/components/schemas/ShippingRateTierType' + CartsConfiguration: + type: "object" + properties: + countryTaxRateFallbackEnabled: + type: "boolean" + deleteDaysAfterLastModification: + type: "integer" + format: "int64" + ExternalOAuth: + type: "object" + properties: + url: + type: "string" + authorizationHeader: + type: "string" + OrderSearchStatus: + type: "string" + enum: + - Activated + - Deactivated + x-annotation-package: "Project" + x-beta: true + Project: + type: "object" + properties: + version: + type: "integer" + format: "int64" + key: + type: "string" + name: + type: "string" + countries: + type: "array" + items: + $ref: '#/components/schemas/CountryCode' + currencies: + type: "array" + items: + $ref: '#/components/schemas/CurrencyCode' + languages: + type: "array" + items: + $ref: '#/components/schemas/Locale' + createdAt: + type: "string" + format: "datetime" + trialUntil: + type: "string" + messages: + $ref: '#/components/schemas/MessageConfiguration' + shippingRateInputType: + $ref: '#/components/schemas/ShippingRateInputType' + externalOAuth: + $ref: '#/components/schemas/ExternalOAuth' + carts: + $ref: '#/components/schemas/CartsConfiguration' + searchIndexing: + $ref: '#/components/schemas/SearchIndexingConfiguration' + shoppingLists: + $ref: '#/components/schemas/ShoppingListsConfiguration' + ProjectUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/ProjectUpdateAction' + ProjectUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + changeCartsConfiguration: '#/components/schemas/ProjectChangeCartsConfigurationAction' + changeCountries: '#/components/schemas/ProjectChangeCountriesAction' + changeCountryTaxRateFallbackEnabled: '#/components/schemas/ProjectChangeCountryTaxRateFallbackEnabledAction' + changeCurrencies: '#/components/schemas/ProjectChangeCurrenciesAction' + changeLanguages: '#/components/schemas/ProjectChangeLanguagesAction' + changeMessagesConfiguration: '#/components/schemas/ProjectChangeMessagesConfigurationAction' + changeMessagesEnabled: '#/components/schemas/ProjectChangeMessagesEnabledAction' + changeName: '#/components/schemas/ProjectChangeNameAction' + changeOrderSearchStatus: '#/components/schemas/ProjectChangeOrderSearchStatusAction' + changeProductSearchIndexingEnabled: '#/components/schemas/ProjectChangeProductSearchIndexingEnabledAction' + changeShoppingListsConfiguration: '#/components/schemas/ProjectChangeShoppingListsConfigurationAction' + setExternalOAuth: '#/components/schemas/ProjectSetExternalOAuthAction' + setShippingRateInputType: '#/components/schemas/ProjectSetShippingRateInputTypeAction' + properties: + action: + type: "string" + SearchIndexingConfiguration: + type: "object" + properties: + products: + $ref: '#/components/schemas/SearchIndexingConfigurationValues' + orders: + $ref: '#/components/schemas/SearchIndexingConfigurationValues' + SearchIndexingConfigurationStatus: + type: "string" + enum: + - Activated + - Deactivated + - Indexing + x-annotation-package: "Project" + SearchIndexingConfigurationValues: + type: "object" + properties: + status: + $ref: '#/components/schemas/SearchIndexingConfigurationStatus' + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + ShippingRateInputType: + type: "object" + discriminator: + propertyName: type + mapping: + CartClassification: '#/components/schemas/CartClassificationType' + CartScore: '#/components/schemas/CartScoreType' + CartValue: '#/components/schemas/CartValueType' + properties: + type: + $ref: '#/components/schemas/ShippingRateTierType' + ShoppingListsConfiguration: + type: "object" + properties: + deleteDaysAfterLastModification: + type: "integer" + format: "int64" + ProjectChangeCartsConfigurationAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + cartsConfiguration: + $ref: '#/components/schemas/CartsConfiguration' + ProjectChangeCountriesAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + countries: + type: "array" + items: + $ref: '#/components/schemas/CountryCode' + ProjectChangeCountryTaxRateFallbackEnabledAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + countryTaxRateFallbackEnabled: + type: "boolean" + ProjectChangeCurrenciesAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + currencies: + type: "array" + items: + $ref: '#/components/schemas/CurrencyCode' + ProjectChangeLanguagesAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + languages: + type: "array" + items: + $ref: '#/components/schemas/Locale' + ProjectChangeMessagesConfigurationAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + messagesConfiguration: + $ref: '#/components/schemas/MessageConfigurationDraft' + ProjectChangeMessagesEnabledAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + messagesEnabled: + type: "boolean" + ProjectChangeNameAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + ProjectChangeOrderSearchStatusAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + status: + $ref: '#/components/schemas/OrderSearchStatus' + ProjectChangeProductSearchIndexingEnabledAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + enabled: + type: "boolean" + ProjectChangeShoppingListsConfigurationAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + shoppingListsConfiguration: + $ref: '#/components/schemas/ShoppingListsConfiguration' + ProjectSetExternalOAuthAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + externalOAuth: + $ref: '#/components/schemas/ExternalOAuth' + ProjectSetShippingRateInputTypeAction: + allOf: + - $ref: '#/components/schemas/ProjectUpdateAction' + - type: "object" + properties: + action: + type: "string" + shippingRateInputType: + $ref: '#/components/schemas/ShippingRateInputType' + Review: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + uniquenessValue: + type: "string" + locale: + type: "string" + authorName: + type: "string" + title: + type: "string" + text: + type: "string" + target: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + includedInStatistics: + type: "boolean" + rating: + type: "integer" + format: "int32" + state: + $ref: '#/components/schemas/StateReference' + customer: + $ref: '#/components/schemas/CustomerReference' + custom: + $ref: '#/components/schemas/CustomFields' + ReviewDraft: + type: "object" + properties: + key: + type: "string" + uniquenessValue: + type: "string" + locale: + type: "string" + authorName: + type: "string" + title: + type: "string" + text: + type: "string" + target: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + state: + $ref: '#/components/schemas/StateResourceIdentifier' + rating: + type: "integer" + format: "int32" + customer: + $ref: '#/components/schemas/CustomerResourceIdentifier' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + ReviewPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Review' + ReviewRatingStatistics: + type: "object" + properties: + averageRating: + type: "number" + format: "double" + highestRating: + type: "number" + format: "double" + lowestRating: + type: "number" + format: "double" + count: + type: "integer" + format: "int32" + ratingsDistribution: + type: "string" + additionalProperties: true + ReviewReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/Review' + ReviewResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + ReviewUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/ReviewUpdateAction' + ReviewUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + setAuthorName: '#/components/schemas/ReviewSetAuthorNameAction' + setCustomField: '#/components/schemas/ReviewSetCustomFieldAction' + setCustomType: '#/components/schemas/ReviewSetCustomTypeAction' + setCustomer: '#/components/schemas/ReviewSetCustomerAction' + setKey: '#/components/schemas/ReviewSetKeyAction' + setLocale: '#/components/schemas/ReviewSetLocaleAction' + setRating: '#/components/schemas/ReviewSetRatingAction' + setTarget: '#/components/schemas/ReviewSetTargetAction' + setText: '#/components/schemas/ReviewSetTextAction' + setTitle: '#/components/schemas/ReviewSetTitleAction' + transitionState: '#/components/schemas/ReviewTransitionStateAction' + properties: + action: + type: "string" + ReviewSetAuthorNameAction: + allOf: + - $ref: '#/components/schemas/ReviewUpdateAction' + - type: "object" + properties: + action: + type: "string" + authorName: + type: "string" + ReviewSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/ReviewUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + ReviewSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/ReviewUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + ReviewSetCustomerAction: + allOf: + - $ref: '#/components/schemas/ReviewUpdateAction' + - type: "object" + properties: + action: + type: "string" + customer: + $ref: '#/components/schemas/CustomerResourceIdentifier' + ReviewSetKeyAction: + allOf: + - $ref: '#/components/schemas/ReviewUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + ReviewSetLocaleAction: + allOf: + - $ref: '#/components/schemas/ReviewUpdateAction' + - type: "object" + properties: + action: + type: "string" + locale: + type: "string" + ReviewSetRatingAction: + allOf: + - $ref: '#/components/schemas/ReviewUpdateAction' + - type: "object" + properties: + action: + type: "string" + rating: + type: "integer" + format: "int32" + ReviewSetTargetAction: + allOf: + - $ref: '#/components/schemas/ReviewUpdateAction' + - type: "object" + properties: + action: + type: "string" + target: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + ReviewSetTextAction: + allOf: + - $ref: '#/components/schemas/ReviewUpdateAction' + - type: "object" + properties: + action: + type: "string" + text: + type: "string" + ReviewSetTitleAction: + allOf: + - $ref: '#/components/schemas/ReviewUpdateAction' + - type: "object" + properties: + action: + type: "string" + title: + type: "string" + ReviewTransitionStateAction: + allOf: + - $ref: '#/components/schemas/ReviewUpdateAction' + - type: "object" + properties: + action: + type: "string" + state: + $ref: '#/components/schemas/StateResourceIdentifier' + force: + type: "boolean" + CartClassificationTier: + allOf: + - $ref: '#/components/schemas/ShippingRatePriceTier' + - type: "object" + properties: + type: + $ref: '#/components/schemas/ShippingRateTierType' + value: + type: "string" + price: + $ref: '#/components/schemas/Money' + isMatching: + type: "boolean" + CartScoreTier: + allOf: + - $ref: '#/components/schemas/ShippingRatePriceTier' + - type: "object" + properties: + type: + $ref: '#/components/schemas/ShippingRateTierType' + score: + type: "number" + format: "double" + price: + $ref: '#/components/schemas/Money' + priceFunction: + $ref: '#/components/schemas/PriceFunction' + isMatching: + type: "boolean" + CartValueTier: + allOf: + - $ref: '#/components/schemas/ShippingRatePriceTier' + - type: "object" + properties: + type: + $ref: '#/components/schemas/ShippingRateTierType' + minimumCentAmount: + type: "integer" + format: "int64" + price: + $ref: '#/components/schemas/Money' + isMatching: + type: "boolean" + PriceFunction: + type: "object" + properties: + currencyCode: + $ref: '#/components/schemas/CurrencyCode' + function: + type: "string" + ShippingMethod: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + name: + type: "string" + localizedName: + $ref: '#/components/schemas/LocalizedString' + description: + type: "string" + localizedDescription: + $ref: '#/components/schemas/LocalizedString' + taxCategory: + $ref: '#/components/schemas/TaxCategoryReference' + zoneRates: + type: "array" + items: + $ref: '#/components/schemas/ZoneRate' + isDefault: + type: "boolean" + predicate: + type: "string" + custom: + $ref: '#/components/schemas/CustomFields' + ShippingMethodDraft: + type: "object" + properties: + key: + type: "string" + name: + type: "string" + localizedName: + $ref: '#/components/schemas/LocalizedString' + description: + type: "string" + localizedDescription: + $ref: '#/components/schemas/LocalizedString' + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + zoneRates: + type: "array" + items: + $ref: '#/components/schemas/ZoneRateDraft' + isDefault: + type: "boolean" + predicate: + type: "string" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + ShippingMethodPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/ShippingMethod' + ShippingMethodReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/ShippingMethod' + ShippingMethodResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + ShippingMethodUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/ShippingMethodUpdateAction' + ShippingMethodUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addShippingRate: '#/components/schemas/ShippingMethodAddShippingRateAction' + addZone: '#/components/schemas/ShippingMethodAddZoneAction' + changeIsDefault: '#/components/schemas/ShippingMethodChangeIsDefaultAction' + changeName: '#/components/schemas/ShippingMethodChangeNameAction' + changeTaxCategory: '#/components/schemas/ShippingMethodChangeTaxCategoryAction' + removeShippingRate: '#/components/schemas/ShippingMethodRemoveShippingRateAction' + removeZone: '#/components/schemas/ShippingMethodRemoveZoneAction' + setCustomField: '#/components/schemas/ShippingMethodSetCustomFieldAction' + setCustomType: '#/components/schemas/ShippingMethodSetCustomTypeAction' + setDescription: '#/components/schemas/ShippingMethodSetDescriptionAction' + setKey: '#/components/schemas/ShippingMethodSetKeyAction' + setLocalizedDescription: '#/components/schemas/ShippingMethodSetLocalizedDescriptionAction' + setLocalizedName: '#/components/schemas/ShippingMethodSetLocalizedNameAction' + setPredicate: '#/components/schemas/ShippingMethodSetPredicateAction' + properties: + action: + type: "string" + ShippingRate: + type: "object" + properties: + price: + $ref: '#/components/schemas/TypedMoney' + freeAbove: + $ref: '#/components/schemas/TypedMoney' + isMatching: + type: "boolean" + tiers: + type: "array" + items: + $ref: '#/components/schemas/ShippingRatePriceTier' + ShippingRateDraft: + type: "object" + properties: + price: + $ref: '#/components/schemas/Money' + freeAbove: + $ref: '#/components/schemas/Money' + tiers: + type: "array" + items: + $ref: '#/components/schemas/ShippingRatePriceTier' + ShippingRatePriceTier: + type: "object" + discriminator: + propertyName: type + mapping: + CartClassification: '#/components/schemas/CartClassificationTier' + CartScore: '#/components/schemas/CartScoreTier' + CartValue: '#/components/schemas/CartValueTier' + properties: + type: + $ref: '#/components/schemas/ShippingRateTierType' + ShippingRateTierType: + type: "string" + enum: + - CartValue + - CartClassification + - CartScore + x-annotation-package: "ShippingMethod" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-shippingMethods.html#shippingratepricetier" + ZoneRate: + type: "object" + properties: + zone: + $ref: '#/components/schemas/ZoneReference' + shippingRates: + type: "array" + items: + $ref: '#/components/schemas/ShippingRate' + ZoneRateDraft: + type: "object" + properties: + zone: + $ref: '#/components/schemas/ZoneResourceIdentifier' + shippingRates: + type: "array" + items: + $ref: '#/components/schemas/ShippingRateDraft' + ShippingMethodAddShippingRateAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + zone: + $ref: '#/components/schemas/ZoneResourceIdentifier' + shippingRate: + $ref: '#/components/schemas/ShippingRateDraft' + ShippingMethodAddZoneAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + zone: + $ref: '#/components/schemas/ZoneResourceIdentifier' + ShippingMethodChangeIsDefaultAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + isDefault: + type: "boolean" + ShippingMethodChangeNameAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + ShippingMethodChangeTaxCategoryAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxCategory: + $ref: '#/components/schemas/TaxCategoryResourceIdentifier' + ShippingMethodRemoveShippingRateAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + zone: + $ref: '#/components/schemas/ZoneResourceIdentifier' + shippingRate: + $ref: '#/components/schemas/ShippingRateDraft' + ShippingMethodRemoveZoneAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + zone: + $ref: '#/components/schemas/ZoneResourceIdentifier' + ShippingMethodSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + ShippingMethodSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + ShippingMethodSetDescriptionAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + type: "string" + ShippingMethodSetKeyAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + ShippingMethodSetLocalizedDescriptionAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + localizedDescription: + $ref: '#/components/schemas/LocalizedString' + ShippingMethodSetLocalizedNameAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + localizedName: + $ref: '#/components/schemas/LocalizedString' + ShippingMethodSetPredicateAction: + allOf: + - $ref: '#/components/schemas/ShippingMethodUpdateAction' + - type: "object" + properties: + action: + type: "string" + predicate: + type: "string" + ShoppingList: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + custom: + $ref: '#/components/schemas/CustomFields' + customer: + $ref: '#/components/schemas/CustomerReference' + deleteDaysAfterLastModification: + type: "integer" + format: "int64" + description: + $ref: '#/components/schemas/LocalizedString' + key: + type: "string" + lineItems: + type: "array" + items: + $ref: '#/components/schemas/ShoppingListLineItem' + name: + $ref: '#/components/schemas/LocalizedString' + slug: + $ref: '#/components/schemas/LocalizedString' + textLineItems: + type: "array" + items: + $ref: '#/components/schemas/TextLineItem' + anonymousId: + type: "string" + store: + $ref: '#/components/schemas/StoreKeyReference' + ShoppingListDraft: + type: "object" + properties: + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + customer: + $ref: '#/components/schemas/CustomerResourceIdentifier' + deleteDaysAfterLastModification: + type: "integer" + format: "int64" + description: + $ref: '#/components/schemas/LocalizedString' + key: + type: "string" + lineItems: + type: "array" + items: + $ref: '#/components/schemas/ShoppingListLineItemDraft' + name: + $ref: '#/components/schemas/LocalizedString' + slug: + $ref: '#/components/schemas/LocalizedString' + textLineItems: + type: "array" + items: + $ref: '#/components/schemas/TextLineItemDraft' + anonymousId: + type: "string" + store: + $ref: '#/components/schemas/StoreResourceIdentifier' + ShoppingListLineItem: + type: "object" + properties: + addedAt: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFields' + deactivatedAt: + type: "string" + format: "datetime" + id: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + productId: + type: "string" + productSlug: + $ref: '#/components/schemas/LocalizedString' + productType: + $ref: '#/components/schemas/ProductTypeReference' + quantity: + type: "integer" + format: "int32" + variant: + $ref: '#/components/schemas/ProductVariant' + variantId: + type: "integer" + format: "int64" + ShoppingListLineItemDraft: + type: "object" + properties: + addedAt: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + sku: + type: "string" + productId: + type: "string" + quantity: + type: "integer" + format: "int32" + variantId: + type: "integer" + format: "int64" + ShoppingListPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/ShoppingList' + ShoppingListReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/ShoppingList' + ShoppingListResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + ShoppingListUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/ShoppingListUpdateAction' + ShoppingListUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addLineItem: '#/components/schemas/ShoppingListAddLineItemAction' + addTextLineItem: '#/components/schemas/ShoppingListAddTextLineItemAction' + changeLineItemQuantity: '#/components/schemas/ShoppingListChangeLineItemQuantityAction' + changeLineItemsOrder: '#/components/schemas/ShoppingListChangeLineItemsOrderAction' + changeName: '#/components/schemas/ShoppingListChangeNameAction' + changeTextLineItemName: '#/components/schemas/ShoppingListChangeTextLineItemNameAction' + changeTextLineItemQuantity: '#/components/schemas/ShoppingListChangeTextLineItemQuantityAction' + changeTextLineItemsOrder: '#/components/schemas/ShoppingListChangeTextLineItemsOrderAction' + removeLineItem: '#/components/schemas/ShoppingListRemoveLineItemAction' + removeTextLineItem: '#/components/schemas/ShoppingListRemoveTextLineItemAction' + setAnonymousId: '#/components/schemas/ShoppingListSetAnonymousIdAction' + setCustomField: '#/components/schemas/ShoppingListSetCustomFieldAction' + setCustomType: '#/components/schemas/ShoppingListSetCustomTypeAction' + setCustomer: '#/components/schemas/ShoppingListSetCustomerAction' + setDeleteDaysAfterLastModification: '#/components/schemas/ShoppingListSetDeleteDaysAfterLastModificationAction' + setDescription: '#/components/schemas/ShoppingListSetDescriptionAction' + setKey: '#/components/schemas/ShoppingListSetKeyAction' + setLineItemCustomField: '#/components/schemas/ShoppingListSetLineItemCustomFieldAction' + setLineItemCustomType: '#/components/schemas/ShoppingListSetLineItemCustomTypeAction' + setSlug: '#/components/schemas/ShoppingListSetSlugAction' + setStore: '#/components/schemas/ShoppingListSetStoreAction' + setTextLineItemCustomField: '#/components/schemas/ShoppingListSetTextLineItemCustomFieldAction' + setTextLineItemCustomType: '#/components/schemas/ShoppingListSetTextLineItemCustomTypeAction' + setTextLineItemDescription: '#/components/schemas/ShoppingListSetTextLineItemDescriptionAction' + properties: + action: + type: "string" + TextLineItem: + type: "object" + properties: + addedAt: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFields' + description: + $ref: '#/components/schemas/LocalizedString' + id: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + quantity: + type: "integer" + format: "int32" + TextLineItemDraft: + type: "object" + properties: + addedAt: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + description: + $ref: '#/components/schemas/LocalizedString' + name: + $ref: '#/components/schemas/LocalizedString' + quantity: + type: "integer" + format: "int32" + ShoppingListAddLineItemAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + sku: + type: "string" + productId: + type: "string" + variantId: + type: "integer" + format: "int64" + quantity: + type: "integer" + format: "int64" + addedAt: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + ShoppingListAddTextLineItemAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + quantity: + type: "integer" + format: "int64" + addedAt: + type: "string" + format: "datetime" + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + ShoppingListChangeLineItemQuantityAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + ShoppingListChangeLineItemsOrderAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemOrder: + type: "array" + items: + type: "string" + ShoppingListChangeNameAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + ShoppingListChangeTextLineItemNameAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + ShoppingListChangeTextLineItemQuantityAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + ShoppingListChangeTextLineItemsOrderAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemOrder: + type: "array" + items: + type: "string" + ShoppingListRemoveLineItemAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + ShoppingListRemoveTextLineItemAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + quantity: + type: "integer" + format: "int64" + ShoppingListSetAnonymousIdAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + anonymousId: + type: "string" + ShoppingListSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + ShoppingListSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + ShoppingListSetCustomerAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + customer: + $ref: '#/components/schemas/CustomerResourceIdentifier' + ShoppingListSetDeleteDaysAfterLastModificationAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + deleteDaysAfterLastModification: + type: "integer" + format: "int64" + ShoppingListSetDescriptionAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + ShoppingListSetKeyAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + ShoppingListSetLineItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + ShoppingListSetLineItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + lineItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + ShoppingListSetSlugAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + slug: + $ref: '#/components/schemas/LocalizedString' + ShoppingListSetStoreAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + store: + $ref: '#/components/schemas/StoreResourceIdentifier' + ShoppingListSetTextLineItemCustomFieldAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + ShoppingListSetTextLineItemCustomTypeAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + ShoppingListSetTextLineItemDescriptionAction: + allOf: + - $ref: '#/components/schemas/ShoppingListUpdateAction' + - type: "object" + properties: + action: + type: "string" + textLineItemId: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + State: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + type: + $ref: '#/components/schemas/StateTypeEnum' + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + initial: + type: "boolean" + builtIn: + type: "boolean" + roles: + type: "array" + items: + $ref: '#/components/schemas/StateRoleEnum' + transitions: + type: "array" + items: + $ref: '#/components/schemas/StateReference' + StateDraft: + type: "object" + properties: + key: + type: "string" + type: + $ref: '#/components/schemas/StateTypeEnum' + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + initial: + type: "boolean" + roles: + type: "array" + items: + $ref: '#/components/schemas/StateRoleEnum' + transitions: + type: "array" + items: + $ref: '#/components/schemas/StateResourceIdentifier' + StatePagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/State' + StateReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/State' + StateResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + StateRoleEnum: + type: "string" + enum: + - ReviewIncludedInStatistics + - Return + x-annotation-package: "State" + x-annotation-docs-uri: "https://docs.commercetools.com/api/projects/states#stateroleenum" + x-annotation-enumDescriptions: + ReviewIncludedInStatistics: "If a [Review's](ctp:api:type:Review) `state` has this + role its `rating` is taken into account for [ReviewRatingStatistics](ctp:api:type:ReviewRatingStatistics). + This role only applies for the `ReviewState` [StateTypeEnum](ctp:api:type:StateTypeEnum)." + Return: "Used by [Orders](ctp:api:type:Order) in the update action [transitionLineItemState](ctp:api:type:OrderTransitionLineItemStateAction). + This role only applies for the `LineItemState` [StateTypeEnum](ctp:api:type:StateTypeEnum)." + StateTypeEnum: + type: "string" + enum: + - OrderState + - LineItemState + - ProductState + - ReviewState + - PaymentState + x-annotation-package: "State" + x-annotation-enumDescriptions: + OrderState: "Used by [Orders](ctp:api:type:Order)." + LineItemState: "Used by [LineItems](ctp:api:type:LineItem) and [CustomLineItems](ctp:api:type:CustomLineItem) + in [Carts](ctp:api:type:Cart) and [Orders](ctp:api:type:Order)." + ProductState: "Used by [Products](ctp:api:type:Product)." + ReviewState: "Used by [Reviews](ctp:api:type:Review)." + PaymentState: "Used by [PaymentStatus](ctp:api:type:PaymentStatus) in [Payments](ctp:api:type:Payment)." + StateUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/StateUpdateAction' + StateUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addRoles: '#/components/schemas/StateAddRolesAction' + changeInitial: '#/components/schemas/StateChangeInitialAction' + changeKey: '#/components/schemas/StateChangeKeyAction' + changeType: '#/components/schemas/StateChangeTypeAction' + removeRoles: '#/components/schemas/StateRemoveRolesAction' + setDescription: '#/components/schemas/StateSetDescriptionAction' + setName: '#/components/schemas/StateSetNameAction' + setRoles: '#/components/schemas/StateSetRolesAction' + setTransitions: '#/components/schemas/StateSetTransitionsAction' + properties: + action: + type: "string" + StateAddRolesAction: + allOf: + - $ref: '#/components/schemas/StateUpdateAction' + - type: "object" + properties: + action: + type: "string" + roles: + type: "array" + items: + $ref: '#/components/schemas/StateRoleEnum' + StateChangeInitialAction: + allOf: + - $ref: '#/components/schemas/StateUpdateAction' + - type: "object" + properties: + action: + type: "string" + initial: + type: "boolean" + StateChangeKeyAction: + allOf: + - $ref: '#/components/schemas/StateUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + StateChangeTypeAction: + allOf: + - $ref: '#/components/schemas/StateUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/StateTypeEnum' + StateRemoveRolesAction: + allOf: + - $ref: '#/components/schemas/StateUpdateAction' + - type: "object" + properties: + action: + type: "string" + roles: + type: "array" + items: + $ref: '#/components/schemas/StateRoleEnum' + StateSetDescriptionAction: + allOf: + - $ref: '#/components/schemas/StateUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + StateSetNameAction: + allOf: + - $ref: '#/components/schemas/StateUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + StateSetRolesAction: + allOf: + - $ref: '#/components/schemas/StateUpdateAction' + - type: "object" + properties: + action: + type: "string" + roles: + type: "array" + items: + $ref: '#/components/schemas/StateRoleEnum' + StateSetTransitionsAction: + allOf: + - $ref: '#/components/schemas/StateUpdateAction' + - type: "object" + properties: + action: + type: "string" + transitions: + type: "array" + items: + $ref: '#/components/schemas/StateResourceIdentifier' + ProductSelectionSetting: + type: "object" + properties: + productSelection: + $ref: '#/components/schemas/ProductSelectionReference' + active: + type: "boolean" + ProductSelectionSettingDraft: + type: "object" + properties: + productSelection: + $ref: '#/components/schemas/ProductSelectionResourceIdentifier' + active: + type: "boolean" + Store: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + languages: + type: "array" + items: + type: "string" + distributionChannels: + type: "array" + items: + $ref: '#/components/schemas/ChannelReference' + supplyChannels: + type: "array" + items: + $ref: '#/components/schemas/ChannelReference' + productSelections: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionSetting' + custom: + $ref: '#/components/schemas/CustomFields' + StoreDraft: + type: "object" + properties: + key: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + languages: + type: "array" + items: + type: "string" + distributionChannels: + type: "array" + items: + $ref: '#/components/schemas/ChannelResourceIdentifier' + supplyChannels: + type: "array" + items: + $ref: '#/components/schemas/ChannelResourceIdentifier' + productSelections: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionSettingDraft' + custom: + $ref: '#/components/schemas/CustomFieldsDraft' + StoreKeyReference: + allOf: + - $ref: '#/components/schemas/KeyReference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + key: + type: "string" + StorePagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Store' + StoreReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/Store' + StoreResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + StoreUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/StoreUpdateAction' + StoreUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addDistributionChannel: '#/components/schemas/StoreAddDistributionChannelAction' + addProductSelection: '#/components/schemas/StoreAddProductSelectionAction' + addSupplyChannel: '#/components/schemas/StoreAddSupplyChannelAction' + changeProductSelectionActive: '#/components/schemas/StoreChangeProductSelectionAction' + removeDistributionChannel: '#/components/schemas/StoreRemoveDistributionChannelAction' + removeProductSelection: '#/components/schemas/StoreRemoveProductSelectionAction' + removeSupplyChannel: '#/components/schemas/StoreRemoveSupplyChannelAction' + setCustomField: '#/components/schemas/StoreSetCustomFieldAction' + setCustomType: '#/components/schemas/StoreSetCustomTypeAction' + setDistributionChannels: '#/components/schemas/StoreSetDistributionChannelsAction' + setLanguages: '#/components/schemas/StoreSetLanguagesAction' + setName: '#/components/schemas/StoreSetNameAction' + setProductSelections: '#/components/schemas/StoreSetProductSelectionsAction' + setSupplyChannels: '#/components/schemas/StoreSetSupplyChannelsAction' + properties: + action: + type: "string" + StoreAddDistributionChannelAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + StoreAddProductSelectionAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + productSelection: + $ref: '#/components/schemas/ProductSelectionSettingDraft' + StoreAddSupplyChannelAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + StoreChangeProductSelectionAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + productSelection: + $ref: '#/components/schemas/ResourceIdentifier' + active: + type: "boolean" + StoreRemoveDistributionChannelAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + distributionChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + StoreRemoveProductSelectionAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + productSelection: + $ref: '#/components/schemas/ResourceIdentifier' + StoreRemoveSupplyChannelAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + supplyChannel: + $ref: '#/components/schemas/ChannelResourceIdentifier' + StoreSetCustomFieldAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + value: + anyOf: + - type: "string" + - type: "object" + - type: "array" + items: + type: "string" + - type: "number" + - type: "integer" + - type: "boolean" + StoreSetCustomTypeAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + type: "string" + additionalProperties: true + StoreSetDistributionChannelsAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + distributionChannels: + type: "array" + items: + $ref: '#/components/schemas/ChannelResourceIdentifier' + StoreSetLanguagesAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + languages: + type: "array" + items: + type: "string" + StoreSetNameAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + StoreSetProductSelectionsAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + productSelections: + type: "array" + items: + $ref: '#/components/schemas/ProductSelectionSettingDraft' + StoreSetSupplyChannelsAction: + allOf: + - $ref: '#/components/schemas/StoreUpdateAction' + - type: "object" + properties: + action: + type: "string" + supplyChannels: + type: "array" + items: + $ref: '#/components/schemas/ChannelResourceIdentifier' + AzureEventGridDestination: + allOf: + - $ref: '#/components/schemas/Destination' + - type: "object" + properties: + type: + type: "string" + uri: + type: "string" + accessKey: + type: "string" + AzureServiceBusDestination: + allOf: + - $ref: '#/components/schemas/Destination' + - type: "object" + properties: + type: + type: "string" + connectionString: + type: "string" + ChangeSubscription: + type: "object" + properties: + resourceTypeId: + type: "string" + DeliveryCloudEventsFormat: + allOf: + - $ref: '#/components/schemas/DeliveryFormat' + - type: "object" + properties: + type: + type: "string" + cloudEventsVersion: + type: "string" + DeliveryFormat: + type: "object" + discriminator: + propertyName: type + mapping: + CloudEvents: '#/components/schemas/DeliveryCloudEventsFormat' + Platform: '#/components/schemas/DeliveryPlatformFormat' + properties: + type: + type: "string" + DeliveryPlatformFormat: + allOf: + - $ref: '#/components/schemas/DeliveryFormat' + - type: "object" + properties: + type: + type: "string" + Destination: + type: "object" + discriminator: + propertyName: type + mapping: + EventGrid: '#/components/schemas/AzureEventGridDestination' + AzureServiceBus: '#/components/schemas/AzureServiceBusDestination' + EventBridge: '#/components/schemas/EventBridgeDestination' + GoogleCloudPubSub: '#/components/schemas/GoogleCloudPubSubDestination' + IronMQ: '#/components/schemas/IronMqDestination' + SNS: '#/components/schemas/SnsDestination' + SQS: '#/components/schemas/SqsDestination' + properties: + type: + type: "string" + EventBridgeDestination: + allOf: + - $ref: '#/components/schemas/Destination' + - type: "object" + properties: + type: + type: "string" + region: + type: "string" + accountId: + type: "string" + GoogleCloudPubSubDestination: + allOf: + - $ref: '#/components/schemas/Destination' + - type: "object" + properties: + type: + type: "string" + projectId: + type: "string" + topic: + type: "string" + IronMqDestination: + allOf: + - $ref: '#/components/schemas/Destination' + - type: "object" + properties: + type: + type: "string" + uri: + type: "string" + MessageDelivery: + allOf: + - $ref: '#/components/schemas/SubscriptionDelivery' + - type: "object" + properties: + projectKey: + type: "string" + notificationType: + type: "string" + resource: + $ref: '#/components/schemas/Reference' + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + sequenceNumber: + type: "integer" + format: "int64" + resourceVersion: + type: "integer" + format: "int64" + payloadNotIncluded: + $ref: '#/components/schemas/PayloadNotIncluded' + MessageSubscription: + type: "object" + properties: + resourceTypeId: + type: "string" + types: + type: "array" + items: + type: "string" + PayloadNotIncluded: + type: "object" + properties: + reason: + type: "string" + payloadType: + type: "string" + ResourceCreatedDelivery: + allOf: + - $ref: '#/components/schemas/SubscriptionDelivery' + - type: "object" + properties: + projectKey: + type: "string" + notificationType: + type: "string" + resource: + $ref: '#/components/schemas/Reference' + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + version: + type: "integer" + format: "int64" + modifiedAt: + type: "string" + format: "datetime" + ResourceDeletedDelivery: + allOf: + - $ref: '#/components/schemas/SubscriptionDelivery' + - type: "object" + properties: + projectKey: + type: "string" + notificationType: + type: "string" + resource: + $ref: '#/components/schemas/Reference' + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + version: + type: "integer" + format: "int64" + modifiedAt: + type: "string" + format: "datetime" + dataErasure: + type: "boolean" + ResourceUpdatedDelivery: + allOf: + - $ref: '#/components/schemas/SubscriptionDelivery' + - type: "object" + properties: + projectKey: + type: "string" + notificationType: + type: "string" + resource: + $ref: '#/components/schemas/Reference' + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + version: + type: "integer" + format: "int64" + oldVersion: + type: "integer" + format: "int64" + modifiedAt: + type: "string" + format: "datetime" + SnsDestination: + allOf: + - $ref: '#/components/schemas/Destination' + - type: "object" + properties: + type: + type: "string" + accessKey: + type: "string" + accessSecret: + type: "string" + topicArn: + type: "string" + SqsDestination: + allOf: + - $ref: '#/components/schemas/Destination' + - type: "object" + properties: + type: + type: "string" + accessKey: + type: "string" + accessSecret: + type: "string" + queueUrl: + type: "string" + region: + type: "string" + Subscription: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + changes: + type: "array" + items: + $ref: '#/components/schemas/ChangeSubscription' + destination: + $ref: '#/components/schemas/Destination' + key: + type: "string" + messages: + type: "array" + items: + $ref: '#/components/schemas/MessageSubscription' + format: + $ref: '#/components/schemas/DeliveryFormat' + status: + $ref: '#/components/schemas/SubscriptionHealthStatus' + SubscriptionDelivery: + type: "object" + discriminator: + propertyName: notificationType + mapping: + Message: '#/components/schemas/MessageDelivery' + ResourceCreated: '#/components/schemas/ResourceCreatedDelivery' + ResourceDeleted: '#/components/schemas/ResourceDeletedDelivery' + ResourceUpdated: '#/components/schemas/ResourceUpdatedDelivery' + properties: + projectKey: + type: "string" + notificationType: + type: "string" + resource: + $ref: '#/components/schemas/Reference' + resourceUserProvidedIdentifiers: + $ref: '#/components/schemas/UserProvidedIdentifiers' + SubscriptionDraft: + type: "object" + properties: + changes: + type: "array" + items: + $ref: '#/components/schemas/ChangeSubscription' + destination: + $ref: '#/components/schemas/Destination' + key: + type: "string" + messages: + type: "array" + items: + $ref: '#/components/schemas/MessageSubscription' + format: + $ref: '#/components/schemas/DeliveryFormat' + SubscriptionHealthStatus: + type: "string" + enum: + - Healthy + - ConfigurationError + - ConfigurationErrorDeliveryStopped + - TemporaryError + x-annotation-package: "Subscription" + x-annotation-docs-uri: "https://docs.commercetools.com/http-api-projects-subscriptions.html#subscription-health-status" + SubscriptionPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Subscription' + SubscriptionUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/SubscriptionUpdateAction' + SubscriptionUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + changeDestination: '#/components/schemas/SubscriptionChangeDestinationAction' + setChanges: '#/components/schemas/SubscriptionSetChangesAction' + setKey: '#/components/schemas/SubscriptionSetKeyAction' + setMessages: '#/components/schemas/SubscriptionSetMessagesAction' + properties: + action: + type: "string" + SubscriptionChangeDestinationAction: + allOf: + - $ref: '#/components/schemas/SubscriptionUpdateAction' + - type: "object" + properties: + action: + type: "string" + destination: + $ref: '#/components/schemas/Destination' + SubscriptionSetChangesAction: + allOf: + - $ref: '#/components/schemas/SubscriptionUpdateAction' + - type: "object" + properties: + action: + type: "string" + changes: + type: "array" + items: + $ref: '#/components/schemas/ChangeSubscription' + SubscriptionSetKeyAction: + allOf: + - $ref: '#/components/schemas/SubscriptionUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + SubscriptionSetMessagesAction: + allOf: + - $ref: '#/components/schemas/SubscriptionUpdateAction' + - type: "object" + properties: + action: + type: "string" + messages: + type: "array" + items: + $ref: '#/components/schemas/MessageSubscription' + SubRate: + type: "object" + properties: + name: + type: "string" + amount: + type: "number" + format: "double" + TaxCategory: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + name: + type: "string" + description: + type: "string" + rates: + type: "array" + items: + $ref: '#/components/schemas/TaxRate' + key: + type: "string" + TaxCategoryDraft: + type: "object" + properties: + name: + type: "string" + description: + type: "string" + rates: + type: "array" + items: + $ref: '#/components/schemas/TaxRateDraft' + key: + type: "string" + TaxCategoryPagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/TaxCategory' + TaxCategoryReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/TaxCategory' + TaxCategoryResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + TaxCategoryUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/TaxCategoryUpdateAction' + TaxCategoryUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addTaxRate: '#/components/schemas/TaxCategoryAddTaxRateAction' + changeName: '#/components/schemas/TaxCategoryChangeNameAction' + removeTaxRate: '#/components/schemas/TaxCategoryRemoveTaxRateAction' + replaceTaxRate: '#/components/schemas/TaxCategoryReplaceTaxRateAction' + setDescription: '#/components/schemas/TaxCategorySetDescriptionAction' + setKey: '#/components/schemas/TaxCategorySetKeyAction' + properties: + action: + type: "string" + TaxRate: + type: "object" + properties: + id: + type: "string" + name: + type: "string" + amount: + type: "number" + format: "double" + includedInPrice: + type: "boolean" + country: + $ref: '#/components/schemas/CountryCode' + state: + type: "string" + subRates: + type: "array" + items: + $ref: '#/components/schemas/SubRate' + TaxRateDraft: + type: "object" + properties: + name: + type: "string" + amount: + type: "number" + format: "double" + includedInPrice: + type: "boolean" + country: + $ref: '#/components/schemas/CountryCode' + state: + type: "string" + subRates: + type: "array" + items: + $ref: '#/components/schemas/SubRate' + TaxCategoryAddTaxRateAction: + allOf: + - $ref: '#/components/schemas/TaxCategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxRate: + $ref: '#/components/schemas/TaxRateDraft' + TaxCategoryChangeNameAction: + allOf: + - $ref: '#/components/schemas/TaxCategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + TaxCategoryRemoveTaxRateAction: + allOf: + - $ref: '#/components/schemas/TaxCategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxRateId: + type: "string" + TaxCategoryReplaceTaxRateAction: + allOf: + - $ref: '#/components/schemas/TaxCategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + taxRateId: + type: "string" + taxRate: + $ref: '#/components/schemas/TaxRateDraft' + TaxCategorySetDescriptionAction: + allOf: + - $ref: '#/components/schemas/TaxCategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + type: "string" + TaxCategorySetKeyAction: + allOf: + - $ref: '#/components/schemas/TaxCategoryUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + CustomFieldBooleanType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + CustomFieldDateTimeType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + CustomFieldDateType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + CustomFieldEnumType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + values: + type: "array" + items: + $ref: '#/components/schemas/CustomFieldEnumValue' + CustomFieldEnumValue: + type: "object" + properties: + key: + type: "string" + label: + type: "string" + CustomFieldLocalizedEnumType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + values: + type: "array" + items: + $ref: '#/components/schemas/CustomFieldLocalizedEnumValue' + CustomFieldLocalizedEnumValue: + type: "object" + properties: + key: + type: "string" + label: + $ref: '#/components/schemas/LocalizedString' + CustomFieldLocalizedStringType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + CustomFieldMoneyType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + CustomFieldNumberType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + CustomFieldReferenceType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + referenceTypeId: + $ref: '#/components/schemas/ReferenceTypeId' + CustomFieldSetType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + elementType: + $ref: '#/components/schemas/FieldType' + CustomFieldStringType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + CustomFieldTimeType: + allOf: + - $ref: '#/components/schemas/FieldType' + - type: "object" + properties: + name: + type: "string" + CustomFields: + type: "object" + properties: + type: + $ref: '#/components/schemas/TypeReference' + fields: + $ref: '#/components/schemas/FieldContainer' + CustomFieldsDraft: + type: "object" + properties: + type: + $ref: '#/components/schemas/TypeResourceIdentifier' + fields: + $ref: '#/components/schemas/FieldContainer' + FieldContainer: + type: "object" + additionalProperties: + type: "string" + FieldDefinition: + type: "object" + properties: + type: + $ref: '#/components/schemas/FieldType' + name: + type: "string" + label: + $ref: '#/components/schemas/LocalizedString' + required: + type: "boolean" + inputHint: + $ref: '#/components/schemas/TypeTextInputHint' + FieldType: + type: "object" + discriminator: + propertyName: name + mapping: + Boolean: '#/components/schemas/CustomFieldBooleanType' + DateTime: '#/components/schemas/CustomFieldDateTimeType' + Date: '#/components/schemas/CustomFieldDateType' + Enum: '#/components/schemas/CustomFieldEnumType' + LocalizedEnum: '#/components/schemas/CustomFieldLocalizedEnumType' + LocalizedString: '#/components/schemas/CustomFieldLocalizedStringType' + Money: '#/components/schemas/CustomFieldMoneyType' + Number: '#/components/schemas/CustomFieldNumberType' + Reference: '#/components/schemas/CustomFieldReferenceType' + Set: '#/components/schemas/CustomFieldSetType' + String: '#/components/schemas/CustomFieldStringType' + Time: '#/components/schemas/CustomFieldTimeType' + properties: + name: + type: "string" + ResourceTypeId: + type: "string" + enum: + - address + - asset + - category + - channel + - customer + - order + - order-edit + - inventory-entry + - line-item + - custom-line-item + - product-price + - payment + - payment-interface-interaction + - review + - shipping-method + - shopping-list + - shopping-list-text-line-item + - discount-code + - cart-discount + - customer-group + - store + x-annotation-package: "Type" + Type: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + resourceTypeIds: + type: "array" + items: + $ref: '#/components/schemas/ResourceTypeId' + fieldDefinitions: + type: "array" + items: + $ref: '#/components/schemas/FieldDefinition' + TypeDraft: + type: "object" + properties: + key: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + description: + $ref: '#/components/schemas/LocalizedString' + resourceTypeIds: + type: "array" + items: + $ref: '#/components/schemas/ResourceTypeId' + fieldDefinitions: + type: "array" + items: + $ref: '#/components/schemas/FieldDefinition' + TypePagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Type' + TypeReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/Type' + TypeResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + TypeTextInputHint: + type: "string" + enum: + - SingleLine + - MultiLine + x-annotation-package: "Type" + TypeUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/TypeUpdateAction' + TypeUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addEnumValue: '#/components/schemas/TypeAddEnumValueAction' + addFieldDefinition: '#/components/schemas/TypeAddFieldDefinitionAction' + addLocalizedEnumValue: '#/components/schemas/TypeAddLocalizedEnumValueAction' + changeEnumValueLabel: '#/components/schemas/TypeChangeEnumValueLabelAction' + changeEnumValueOrder: '#/components/schemas/TypeChangeEnumValueOrderAction' + changeFieldDefinitionOrder: '#/components/schemas/TypeChangeFieldDefinitionOrderAction' + changeInputHint: '#/components/schemas/TypeChangeInputHintAction' + changeKey: '#/components/schemas/TypeChangeKeyAction' + changeLabel: '#/components/schemas/TypeChangeLabelAction' + changeLocalizedEnumValueLabel: '#/components/schemas/TypeChangeLocalizedEnumValueLabelAction' + changeLocalizedEnumValueOrder: '#/components/schemas/TypeChangeLocalizedEnumValueOrderAction' + changeName: '#/components/schemas/TypeChangeNameAction' + removeFieldDefinition: '#/components/schemas/TypeRemoveFieldDefinitionAction' + setDescription: '#/components/schemas/TypeSetDescriptionAction' + properties: + action: + type: "string" + TypeAddEnumValueAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + fieldName: + type: "string" + value: + $ref: '#/components/schemas/CustomFieldEnumValue' + TypeAddFieldDefinitionAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + fieldDefinition: + $ref: '#/components/schemas/FieldDefinition' + TypeAddLocalizedEnumValueAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + fieldName: + type: "string" + value: + $ref: '#/components/schemas/CustomFieldLocalizedEnumValue' + TypeChangeEnumValueLabelAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + fieldName: + type: "string" + value: + $ref: '#/components/schemas/CustomFieldEnumValue' + TypeChangeEnumValueOrderAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + fieldName: + type: "string" + keys: + type: "array" + items: + type: "string" + TypeChangeFieldDefinitionOrderAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + fieldNames: + type: "array" + items: + type: "string" + TypeChangeInputHintAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + fieldName: + type: "string" + inputHint: + $ref: '#/components/schemas/TypeTextInputHint' + TypeChangeKeyAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + TypeChangeLabelAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + fieldName: + type: "string" + label: + $ref: '#/components/schemas/LocalizedString' + TypeChangeLocalizedEnumValueLabelAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + fieldName: + type: "string" + value: + $ref: '#/components/schemas/CustomFieldLocalizedEnumValue' + TypeChangeLocalizedEnumValueOrderAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + fieldName: + type: "string" + keys: + type: "array" + items: + type: "string" + TypeChangeNameAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + $ref: '#/components/schemas/LocalizedString' + TypeRemoveFieldDefinitionAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + fieldName: + type: "string" + TypeSetDescriptionAction: + allOf: + - $ref: '#/components/schemas/TypeUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + $ref: '#/components/schemas/LocalizedString' + Location: + type: "object" + properties: + country: + $ref: '#/components/schemas/CountryCode' + state: + type: "string" + Zone: + allOf: + - $ref: '#/components/schemas/BaseResource' + - type: "object" + properties: + id: + type: "string" + version: + type: "integer" + format: "int64" + createdAt: + type: "string" + format: "datetime" + lastModifiedAt: + type: "string" + format: "datetime" + lastModifiedBy: + $ref: '#/components/schemas/LastModifiedBy' + createdBy: + $ref: '#/components/schemas/CreatedBy' + key: + type: "string" + name: + type: "string" + description: + type: "string" + locations: + type: "array" + items: + $ref: '#/components/schemas/Location' + ZoneDraft: + type: "object" + properties: + key: + type: "string" + name: + type: "string" + description: + type: "string" + locations: + type: "array" + items: + $ref: '#/components/schemas/Location' + ZonePagedQueryResponse: + type: "object" + properties: + limit: + type: "integer" + format: "int64" + offset: + type: "integer" + format: "int64" + count: + type: "integer" + format: "int64" + total: + type: "integer" + format: "int64" + results: + type: "array" + items: + $ref: '#/components/schemas/Zone' + ZoneReference: + allOf: + - $ref: '#/components/schemas/Reference' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + obj: + $ref: '#/components/schemas/Zone' + ZoneResourceIdentifier: + allOf: + - $ref: '#/components/schemas/ResourceIdentifier' + - type: "object" + properties: + typeId: + $ref: '#/components/schemas/ReferenceTypeId' + id: + type: "string" + key: + type: "string" + ZoneUpdate: + type: "object" + properties: + version: + type: "integer" + format: "int64" + actions: + type: "array" + items: + $ref: '#/components/schemas/ZoneUpdateAction' + ZoneUpdateAction: + type: "object" + discriminator: + propertyName: action + mapping: + addLocation: '#/components/schemas/ZoneAddLocationAction' + changeName: '#/components/schemas/ZoneChangeNameAction' + removeLocation: '#/components/schemas/ZoneRemoveLocationAction' + setDescription: '#/components/schemas/ZoneSetDescriptionAction' + setKey: '#/components/schemas/ZoneSetKeyAction' + properties: + action: + type: "string" + ZoneAddLocationAction: + allOf: + - $ref: '#/components/schemas/ZoneUpdateAction' + - type: "object" + properties: + action: + type: "string" + location: + $ref: '#/components/schemas/Location' + ZoneChangeNameAction: + allOf: + - $ref: '#/components/schemas/ZoneUpdateAction' + - type: "object" + properties: + action: + type: "string" + name: + type: "string" + ZoneRemoveLocationAction: + allOf: + - $ref: '#/components/schemas/ZoneUpdateAction' + - type: "object" + properties: + action: + type: "string" + location: + $ref: '#/components/schemas/Location' + ZoneSetDescriptionAction: + allOf: + - $ref: '#/components/schemas/ZoneUpdateAction' + - type: "object" + properties: + action: + type: "string" + description: + type: "string" + ZoneSetKeyAction: + allOf: + - $ref: '#/components/schemas/ZoneUpdateAction' + - type: "object" + properties: + action: + type: "string" + key: + type: "string" + URLEncodedPayload: + type: "string" + additionalProperties: true diff --git a/openapi/commercetools/types.bal b/openapi/commercetools/types.bal new file mode 100644 index 000000000..fd22d5d41 --- /dev/null +++ b/openapi/commercetools/types.bal @@ -0,0 +1,10675 @@ +// Copyright (c) 2022 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 Inc. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +public type ShoppingListSetStoreAction record { + *ShoppingListUpdateAction; + string action?; + StoreResourceIdentifier store?; +}; + +public type TypeChangeEnumValueOrderAction record { + *TypeUpdateAction; + string action?; + string fieldName?; + string[] keys?; +}; + +public type CartAddShoppingListAction record { + *CartUpdateAction; + string action?; + ShoppingListResourceIdentifier shoppingList?; + ChannelResourceIdentifier supplyChannel?; + ChannelResourceIdentifier distributionChannel?; +}; + +public type ProductSetAssetTagsAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; + string assetId?; + string assetKey?; + string[] tags?; +}; + +public type ProductSetKeyAction record { + *ProductUpdateAction; + string action?; + string 'key?; +}; + +public type ProductDiscountPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + ProductDiscount[] results?; +}; + +public type ZoneRateDraft record { + ZoneResourceIdentifier zone?; + ShippingRateDraft[] shippingRates?; +}; + +public type GraphQLErrorLocation record { + int line?; + int column?; +}; + +public type ProductTypeDraft record { + string 'key?; + string name?; + string description?; + AttributeDefinitionDraft[] attributes?; +}; + +public type AttributeDateType record { + *AttributeType; + string name?; +}; + +public type CurrencyCode string; + +public type CartDiscountChangeSortOrderAction record { + *CartDiscountUpdateAction; + string action?; + string sortOrder?; +}; + +public type Suggestion record { + string text?; +}; + +public type OrderEditAppliedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + OrderEditReference edit?; + OrderEditApplied result?; +}; + +public type CartValueTier record { + *ShippingRatePriceTier; + ShippingRateTierType 'type?; + int minimumCentAmount?; + Money price?; + boolean isMatching?; +}; + +public type CartSetCustomFieldAction record { + *CartUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type IronMqDestination record { + *Destination; + string 'type?; + string uri?; +}; + +public type MyCustomerSetCustomTypeAction record { + *MyCustomerUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ShippingMethodUpdateAction record { + string action?; +}; + +public type ResourceTypeId string; + +public type CartSetShippingAddressCustomTypeAction record { + *CartUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type InventoryEntryCreatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + InventoryEntry inventoryEntry?; +}; + +public type StoreUpdateAction record { + string action?; +}; + +public type TaxMode string; + +public type PaymentInfo record { + PaymentReference[] payments?; +}; + +public type ParcelItemsUpdatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string parcelId?; + string deliveryId?; + DeliveryItem[] items?; + DeliveryItem[] oldItems?; +}; + +public type ProductRemoveFromCategoryAction record { + *ProductUpdateAction; + string action?; + CategoryResourceIdentifier category?; + boolean staged?; +}; + +public type QueryPredicate string; + +public type CartScoreTier record { + *ShippingRatePriceTier; + ShippingRateTierType 'type?; + float score?; + Money price?; + PriceFunction priceFunction?; + boolean isMatching?; +}; + +public type CustomFieldNumberType record { + *FieldType; + string name?; +}; + +public type DiscountedLineItemPortion record { + CartDiscountReference discount?; + TypedMoney discountedAmount?; +}; + +public type CartSetCustomLineItemTaxRateAction record { + *CartUpdateAction; + string action?; + string customLineItemId?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type PaymentStatusInterfaceCodeSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string paymentId?; + string interfaceCode?; +}; + +public type ProductDiscountChangePredicateAction record { + *ProductDiscountUpdateAction; + string action?; + string predicate?; +}; + +public type CustomerGroupPagedQueryResponse record { + int 'limit?; + int offset?; + int count?; + int total?; + CustomerGroup[] results?; +}; + +public type ApiClientDraft record { + string name?; + string scope?; + int deleteDaysAfterCreation?; +}; + +public type MyCustomerSetSalutationAction record { + *MyCustomerUpdateAction; + string action?; + string salutation?; +}; + +public type CategoryRemoveAssetAction record { + *CategoryUpdateAction; + string action?; + string assetId?; + string assetKey?; +}; + +public type DiscountCodeState string; + +public type CategorySetDescriptionAction record { + *CategoryUpdateAction; + string action?; + LocalizedString description?; +}; + +public type ProductPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Product[] results?; +}; + +public type ShippingMethodChangeNameAction record { + *ShippingMethodUpdateAction; + string action?; + string name?; +}; + +public type CartUpdateItemShippingAddressAction record { + *CartUpdateAction; + string action?; + BaseAddress address?; +}; + +public type SearchIndexingConfigurationValues record { + SearchIndexingConfigurationStatus status?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; +}; + +public type ProjectNotConfiguredForLanguagesError record { + *ErrorObject; + string code?; + string message?; + string[] languages?; +}; + +public type DiscountedLineItemPriceDraft record { + Money value?; + DiscountedLineItemPortion[] includedDiscounts?; +}; + +public type DeliveryAddedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Delivery delivery?; +}; + +public type CustomObjectDraft record { + string container?; + string 'key?; + string|record {}|string[]|decimal|int|boolean value?; + int 'version?; +}; + +public type DiscountCodeSetValidUntilAction record { + *DiscountCodeUpdateAction; + string action?; + string validUntil?; +}; + +public type NoMatchingProductDiscountFoundError record { + *ErrorObject; + string code?; + string message?; +}; + +public type CustomerChangeEmailAction record { + *CustomerUpdateAction; + string action?; + string email?; +}; + +public type MyShoppingListSetLineItemCustomFieldAction record { + *MyShoppingListUpdateAction; + string action?; + string lineItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type CustomerRemoveAddressAction record { + *CustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type ShippingRateDraft record { + Money price?; + Money freeAbove?; + ShippingRatePriceTier[] tiers?; +}; + +public type ChannelSetCustomFieldAction record { + *ChannelUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type CustomerSetDefaultBillingAddressAction record { + *CustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type StagedOrderSetCustomFieldAction record { + *StagedOrderUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type TaxedPrice record { + TypedMoney totalNet?; + TypedMoney totalGross?; + TaxPortion[] taxPortions?; +}; + +public type ShippingInfoImportDraft record { + string shippingMethodName?; + Money price?; + ShippingRateDraft shippingRate?; + TaxRate taxRate?; + TaxCategoryResourceIdentifier taxCategory?; + ShippingMethodResourceIdentifier shippingMethod?; + Delivery[] deliveries?; + DiscountedLineItemPriceDraft discountedPrice?; + ShippingMethodState shippingMethodState?; +}; + +public type MyCartSetLineItemDistributionChannelAction record { + *MyCartUpdateAction; + string action?; + string lineItemId?; + ChannelResourceIdentifier distributionChannel?; +}; + +public type InvalidInputError record { + *ErrorObject; + string code?; + string message?; +}; + +public type CustomLineItemStateTransitionMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string customLineItemId?; + string transitionDate?; + int quantity?; + StateReference fromState?; + StateReference toState?; +}; + +public type StoreProductSelectionsChangedMessagePayload record { + *MessagePayload; + string 'type?; + ProductSelectionSetting[] addedProductSelections?; + ProductSelectionSetting[] removedProductSelections?; + ProductSelectionSetting[] updatedProductSelections?; +}; + +public type ProductSetMetaKeywordsAction record { + *ProductUpdateAction; + string action?; + LocalizedString metaKeywords?; + boolean staged?; +}; + +public type OrderSearchQuery string; + +public type ChannelSetRolesAction record { + *ChannelUpdateAction; + string action?; + ChannelRoleEnum[] roles?; +}; + +public type CartDiscountChangeIsActiveAction record { + *CartDiscountUpdateAction; + string action?; + boolean isActive?; +}; + +public type ShippingMethodResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type CustomFieldLocalizedEnumType record { + *FieldType; + string name?; + CustomFieldLocalizedEnumValue[] values?; +}; + +public type OrderStateTransitionMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + StateReference state?; + StateReference oldState?; + boolean force?; +}; + +public type TypeChangeKeyAction record { + *TypeUpdateAction; + string action?; + string 'key?; +}; + +public type CategorySlugChangedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + LocalizedString slug?; + LocalizedString oldSlug?; +}; + +public type CustomerCreatedMessagePayload record { + *MessagePayload; + string 'type?; + Customer customer?; +}; + +public type DiscountCode record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + LocalizedString name?; + LocalizedString description?; + string code?; + CartDiscountReference[] cartDiscounts?; + string cartPredicate?; + boolean isActive?; + Reference[] references?; + int maxApplications?; + int maxApplicationsPerCustomer?; + CustomFields custom?; + string[] groups?; + string validFrom?; + string validUntil?; + int applicationVersion?; +}; + +public type ShoppingListSetAnonymousIdAction record { + *ShoppingListUpdateAction; + string action?; + string anonymousId?; +}; + +public type OrderSetCustomLineItemShippingDetailsAction record { + *OrderUpdateAction; + string action?; + string customLineItemId?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type OutOfStockError record { + *ErrorObject; + string code?; + string message?; + string[] lineItems?; + string[] skus?; +}; + +public type StoreRemoveDistributionChannelAction record { + *StoreUpdateAction; + string action?; + ChannelResourceIdentifier distributionChannel?; +}; + +public type StagedOrderSetParcelCustomTypeAction record { + *StagedOrderUpdateAction; + string action?; + string parcelId?; + TypeResourceIdentifier 'type?; + record {} fields?; +}; + +public type ProductPriceDiscountsSetMessagePayload record { + *MessagePayload; + string 'type?; + ProductPriceDiscountsSetUpdatedPrice[] updatedPrices?; +}; + +public type ProjectChangeOrderSearchStatusAction record { + *ProjectUpdateAction; + string action?; + OrderSearchStatus status?; +}; + +public type ChannelSetAddressAction record { + *ChannelUpdateAction; + string action?; + BaseAddress address?; +}; + +public type OrderLineItemDiscountSetMessagePayload record { + *MessagePayload; + string 'type?; + string lineItemId?; + DiscountedLineItemPriceForQuantity[] discountedPricePerQuantity?; + Money totalPrice?; + TaxedItemPrice taxedPrice?; +}; + +public type MyCustomerChangeAddressAction record { + *MyCustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; + BaseAddress address?; +}; + +public type OrderCustomerGroupSetMessagePayload record { + *MessagePayload; + string 'type?; + CustomerGroupReference customerGroup?; + CustomerGroupReference oldCustomerGroup?; +}; + +public type CategorySetCustomTypeAction record { + *CategoryUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type CustomerUpdate record { + int 'version?; + CustomerUpdateAction[] actions?; +}; + +public type OrderSetDeliveryAddressCustomFieldAction record { + *OrderUpdateAction; + string action?; + string deliveryId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type CategoryResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type ResourceUpdatedDelivery record { + *SubscriptionDelivery; + string projectKey?; + string notificationType?; + Reference 'resource?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + int 'version?; + int oldVersion?; + string modifiedAt?; +}; + +public type ProductDiscountSetKeyAction record { + *ProductDiscountUpdateAction; + string action?; + string 'key?; +}; + +public type AttributeLocalizedEnumType record { + *AttributeType; + string name?; + AttributeLocalizedEnumValue[] values?; +}; + +public type ReviewUpdateAction record { + string action?; +}; + +public type StagedOrderSetReturnInfoAction record { + *StagedOrderUpdateAction; + string action?; + ReturnInfoDraft[] items?; +}; + +public type SubscriptionChangeDestinationAction record { + *SubscriptionUpdateAction; + string action?; + Destination destination?; +}; + +public type LineItemMode string; + +public type CategorySetMetaKeywordsAction record { + *CategoryUpdateAction; + string action?; + LocalizedString metaKeywords?; +}; + +public type ProductSetDescriptionAction record { + *ProductUpdateAction; + string action?; + LocalizedString description?; + boolean staged?; +}; + +public type CartDiscountSetValidFromAction record { + *CartDiscountUpdateAction; + string action?; + string validFrom?; +}; + +public type ProductDiscountReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + ProductDiscount obj?; +}; + +public type PaymentSetTransactionCustomFieldAction record { + *PaymentUpdateAction; + string action?; + string transactionId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type CustomLineItemReturnItem record { + *ReturnItem; + string id?; + int quantity?; + string 'type?; + string comment?; + ReturnShipmentState shipmentState?; + ReturnPaymentState paymentState?; + CustomFields custom?; + string lastModifiedAt?; + string createdAt?; + string customLineItemId?; +}; + +public type StagedOrderSetParcelItemsAction record { + *StagedOrderUpdateAction; + string action?; + string parcelId?; + DeliveryItem[] items?; +}; + +public type CartAddCustomLineItemAction record { + *CartUpdateAction; + string action?; + Money money?; + LocalizedString name?; + int quantity?; + string slug?; + TaxCategoryResourceIdentifier taxCategory?; + CustomFieldsDraft custom?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type CustomObjectReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + CustomObject obj?; +}; + +public type OrderReturnShipmentStateChangedMessagePayload record { + *MessagePayload; + string 'type?; + string returnItemId?; + ReturnShipmentState returnShipmentState?; +}; + +public type OrderUpdateAction record { + string action?; +}; + +public type StateReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + State obj?; +}; + +public type OrderSetCustomerIdAction record { + *OrderUpdateAction; + string action?; + string customerId?; +}; + +public type CustomFieldEnumType record { + *FieldType; + string name?; + CustomFieldEnumValue[] values?; +}; + +public type ProductTypeChangePlainEnumValueLabelAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + AttributePlainEnumValue newValue?; +}; + +public type ShippingMethodSetLocalizedDescriptionAction record { + *ShippingMethodUpdateAction; + string action?; + LocalizedString localizedDescription?; +}; + +public type OrderReturnShipmentStateChangedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string returnItemId?; + ReturnShipmentState returnShipmentState?; +}; + +public type StagedOrderChangeShipmentStateAction record { + *StagedOrderUpdateAction; + string action?; + ShipmentState shipmentState?; +}; + +public type CustomerEmailVerify record { + int 'version?; + string tokenValue?; +}; + +public type CustomFieldLocalizedStringType record { + *FieldType; + string name?; +}; + +public type State record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + StateTypeEnum 'type?; + LocalizedString name?; + LocalizedString description?; + boolean initial?; + boolean builtIn?; + StateRoleEnum[] roles?; + StateReference[] transitions?; +}; + +public type CartSetCustomerIdAction record { + *CartUpdateAction; + string action?; + string customerId?; +}; + +public type ProductPublishScope string; + +public type ExtensionUpdateActionsFailedError record { + *ErrorObject; + string code?; + string message?; + LocalizedString localizedMessage?; + record {} extensionExtraInfo?; + ErrorByExtension errorByExtension?; +}; + +public type ExtensionInput record { + ExtensionAction action?; + Reference 'resource?; +}; + +public type CustomerAddBillingAddressIdAction record { + *CustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type ProductChangeMasterVariantAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; +}; + +public type TransactionType string; + +public type ProductUnpublishAction record { + *ProductUpdateAction; + string action?; +}; + +public type MyCartSetDeleteDaysAfterLastModificationAction record { + *MyCartUpdateAction; + string action?; + int deleteDaysAfterLastModification?; +}; + +public type StateAddRolesAction record { + *StateUpdateAction; + string action?; + StateRoleEnum[] roles?; +}; + +public type ZoneSetKeyAction record { + *ZoneUpdateAction; + string action?; + string 'key?; +}; + +public type CartDiscountValueAbsolute record { + *CartDiscountValue; + string 'type?; + TypedMoney[] money?; +}; + +public type OrderSetParcelCustomTypeAction record { + *OrderUpdateAction; + string action?; + string parcelId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type OrderSetShippingAddressCustomTypeAction record { + *OrderUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type OrderShippingAddressSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Address address?; + Address oldAddress?; +}; + +public type CustomerAddAddressAction record { + *CustomerUpdateAction; + string action?; + BaseAddress address?; +}; + +public type CartDiscountReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + CartDiscount obj?; +}; + +public type DiscountCodeSetDescriptionAction record { + *DiscountCodeUpdateAction; + string action?; + LocalizedString description?; +}; + +public type CartRemovePaymentAction record { + *CartUpdateAction; + string action?; + PaymentResourceIdentifier payment?; +}; + +public type OrderLineItemDistributionChannelSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string lineItemId?; + ChannelReference distributionChannel?; +}; + +public type CartsConfiguration record { + boolean countryTaxRateFallbackEnabled?; + int deleteDaysAfterLastModification?; +}; + +public type CartDraft record { + CurrencyCode currency?; + string 'key?; + string customerId?; + string customerEmail?; + CustomerGroupResourceIdentifier customerGroup?; + string anonymousId?; + StoreResourceIdentifier store?; + string country?; + InventoryMode inventoryMode?; + TaxMode taxMode?; + RoundingMode taxRoundingMode?; + TaxCalculationMode taxCalculationMode?; + LineItemDraft[] lineItems?; + CustomLineItemDraft[] customLineItems?; + BaseAddress shippingAddress?; + BaseAddress billingAddress?; + ShippingMethodResourceIdentifier shippingMethod?; + ExternalTaxRateDraft externalTaxRateForShippingMethod?; + CustomFieldsDraft custom?; + string locale?; + int deleteDaysAfterLastModification?; + CartOrigin origin?; + ShippingRateInputDraft shippingRateInput?; + BaseAddress[] itemShippingAddresses?; + string[] discountCodes?; +}; + +public type OrderTransitionCustomLineItemStateAction record { + *OrderUpdateAction; + string action?; + string customLineItemId?; + int quantity?; + StateResourceIdentifier fromState?; + StateResourceIdentifier toState?; + string actualTransitionDate?; +}; + +public type CustomerGroupSetCustomFieldAction record { + *CustomerGroupUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type DeliveryAddressSetMessagePayload record { + *MessagePayload; + string 'type?; + string deliveryId?; + Address address?; + Address oldAddress?; +}; + +public type CartDiscountSetValidFromAndUntilAction record { + *CartDiscountUpdateAction; + string action?; + string validFrom?; + string validUntil?; +}; + +public type CustomerGroupChangeNameAction record { + *CustomerGroupUpdateAction; + string action?; + string name?; +}; + +public type ChannelChangeKeyAction record { + *ChannelUpdateAction; + string action?; + string 'key?; +}; + +public type ProductChangePriceAction record { + *ProductUpdateAction; + string action?; + string priceId?; + PriceDraft price?; + boolean staged?; +}; + +public type GraphQLVariablesMap record { +}; + +public type ProductDiscountValueExternalDraft record { + *ProductDiscountValueDraft; + string 'type?; +}; + +public type PaymentStatusStateTransitionMessagePayload record { + *MessagePayload; + string 'type?; + StateReference state?; + boolean force?; +}; + +public type CustomTokenizer record { + *SuggestTokenizer; + string 'type?; + string[] inputs?; +}; + +public type ResourceCreatedDelivery record { + *SubscriptionDelivery; + string projectKey?; + string notificationType?; + Reference 'resource?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + int 'version?; + string modifiedAt?; +}; + +public type ProductTypeChangeNameAction record { + *ProductTypeUpdateAction; + string action?; + string name?; +}; + +public type SubscriptionSetChangesAction record { + *SubscriptionUpdateAction; + string action?; + ChangeSubscription[] changes?; +}; + +public type MatchingPriceNotFoundError record { + *ErrorObject; + string code?; + string message?; + string productId?; + int variantId?; + string currency?; + string country?; + CustomerGroupReference customerGroup?; + ChannelReference 'channel?; +}; + +public type ExternalLineItemTotalPrice record { + Money price?; + Money totalPrice?; +}; + +public type CartSetAnonymousIdAction record { + *CartUpdateAction; + string action?; + string anonymousId?; +}; + +public type OrderSetDeliveryAddressAction record { + *OrderUpdateAction; + string action?; + string deliveryId?; + BaseAddress address?; +}; + +public type DiscountCodeUpdateAction record { + string action?; +}; + +public type OrderChangePaymentStateAction record { + *OrderUpdateAction; + string action?; + PaymentState paymentState?; +}; + +public type ProductSelectionResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type ChannelDraft record { + string 'key?; + ChannelRoleEnum[] roles?; + LocalizedString name?; + LocalizedString description?; + BaseAddress address?; + CustomFieldsDraft custom?; + GeoJson geoLocation?; +}; + +public type MyShoppingListChangeTextLineItemNameAction record { + *MyShoppingListUpdateAction; + string action?; + string textLineItemId?; + LocalizedString name?; +}; + +public type OrderSetDeliveryCustomFieldAction record { + *OrderUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type PaymentStatusInterfaceCodeSetMessagePayload record { + *MessagePayload; + string 'type?; + string paymentId?; + string interfaceCode?; +}; + +public type ZonePagedQueryResponse record { + int 'limit?; + int offset?; + int count?; + int total?; + Zone[] results?; +}; + +public type MyShoppingListAddLineItemAction record { + *MyShoppingListUpdateAction; + string action?; + string sku?; + string productId?; + int variantId?; + int quantity?; + string addedAt?; + CustomFieldsDraft custom?; +}; + +public type ProductProjection record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + string 'key?; + ProductTypeReference productType?; + LocalizedString name?; + LocalizedString description?; + LocalizedString slug?; + CategoryReference[] categories?; + CategoryOrderHints categoryOrderHints?; + LocalizedString metaTitle?; + LocalizedString metaDescription?; + LocalizedString metaKeywords?; + SearchKeywords searchKeywords?; + boolean hasStagedChanges?; + boolean published?; + ProductVariant masterVariant?; + ProductVariant[] variants?; + TaxCategoryReference taxCategory?; + StateReference state?; + ReviewRatingStatistics reviewRatingStatistics?; +}; + +public type TaxCategoryPagedQueryResponse record { + int 'limit?; + int offset?; + int count?; + int total?; + TaxCategory[] results?; +}; + +public type InvalidCredentialsError record { + *ErrorObject; + string code?; + string message?; +}; + +public type ProductPriceExternalDiscountSetMessagePayload record { + *MessagePayload; + string 'type?; + int variantId?; + string variantKey?; + string sku?; + string priceId?; + DiscountedPrice discounted?; + boolean staged?; +}; + +public type ReviewSetCustomTypeAction record { + *ReviewUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ProductDiscountSetValidFromAndUntilAction record { + *ProductDiscountUpdateAction; + string action?; + string validFrom?; + string validUntil?; +}; + +public type Asset record { + string id?; + AssetSource[] sources?; + LocalizedString name?; + LocalizedString description?; + string[] tags?; + CustomFields custom?; + string 'key?; +}; + +public type DiscountCodeNonApplicableError record { + *ErrorObject; + string code?; + string message?; + string discountCode?; + string reason?; + string dicountCodeId?; + string validFrom?; + string validUntil?; + string validityCheckTime?; +}; + +public type DiscountCodeSetMaxApplicationsPerCustomerAction record { + *DiscountCodeUpdateAction; + string action?; + int maxApplicationsPerCustomer?; +}; + +public type InventoryEntryUpdate record { + int 'version?; + InventoryEntryUpdateAction[] actions?; +}; + +public type StagedOrderSetLineItemPriceAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + Money externalPrice?; +}; + +public type StagedOrderSetLineItemShippingDetailsAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type ProjectChangeShoppingListsConfigurationAction record { + *ProjectUpdateAction; + string action?; + ShoppingListsConfiguration shoppingListsConfiguration?; +}; + +public type PaymentSetMethodInfoInterfaceAction record { + *PaymentUpdateAction; + string action?; + string interface?; +}; + +public type ProductsInStorePagedQueryResponse record { + int 'limit?; + int offset?; + int count?; + int total?; + ProductSelectionAssignment[] results?; +}; + +public type ShoppingListsConfiguration record { + int deleteDaysAfterLastModification?; +}; + +public type StateSetRolesAction record { + *StateUpdateAction; + string action?; + StateRoleEnum[] roles?; +}; + +public type MyOrderFromCartDraft record { + string id?; + int 'version?; +}; + +public type ZoneRemoveLocationAction record { + *ZoneUpdateAction; + string action?; + Location location?; +}; + +public type MyCustomerRemoveAddressAction record { + *MyCustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type DeliveryAddedMessagePayload record { + *MessagePayload; + string 'type?; + Delivery delivery?; +}; + +public type OrderCustomLineItemDiscountSetMessagePayload record { + *MessagePayload; + string 'type?; + string customLineItemId?; + DiscountedLineItemPriceForQuantity[] discountedPricePerQuantity?; + TaxedItemPrice taxedPrice?; +}; + +public type TaxCategoryAddTaxRateAction record { + *TaxCategoryUpdateAction; + string action?; + TaxRateDraft taxRate?; +}; + +public type MyCartChangeLineItemQuantityAction record { + *MyCartUpdateAction; + string action?; + string lineItemId?; + int quantity?; + Money externalPrice?; + ExternalLineItemTotalPrice externalTotalPrice?; +}; + +public type MyPaymentChangeAmountPlannedAction record { + *MyPaymentUpdateAction; + string action?; + Money amount?; +}; + +public type ProductPriceDiscountsSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ProductPriceDiscountsSetUpdatedPrice[] updatedPrices?; +}; + +public type ReferencedResourceNotFoundError record { + *ErrorObject; + string code?; + string message?; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type CartSetLineItemTaxRateAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type StagedOrderTransitionLineItemStateAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + int quantity?; + StateResourceIdentifier fromState?; + StateResourceIdentifier toState?; + string actualTransitionDate?; +}; + +public type CategorySetAssetCustomFieldAction record { + *CategoryUpdateAction; + string action?; + string assetId?; + string assetKey?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type TypeAddEnumValueAction record { + *TypeUpdateAction; + string action?; + string fieldName?; + CustomFieldEnumValue value?; +}; + +public type OrderState string; + +public type StagedOrderSetLocaleAction record { + *StagedOrderUpdateAction; + string action?; + string locale?; +}; + +public type OrderTransitionStateAction record { + *OrderUpdateAction; + string action?; + StateResourceIdentifier state?; + boolean force?; +}; + +public type ProductLegacySetSkuAction record { + *ProductUpdateAction; + string action?; + string sku?; + int variantId?; +}; + +public type OrderSearchSorting string; + +public type ProductTypeRemoveAttributeDefinitionAction record { + *ProductTypeUpdateAction; + string action?; + string name?; +}; + +public type ExtensionChangeDestinationAction record { + *ExtensionUpdateAction; + string action?; + ExtensionDestination destination?; +}; + +public type StoreProductSelectionsChangedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ProductSelectionSetting[] addedProductSelections?; + ProductSelectionSetting[] removedProductSelections?; + ProductSelectionSetting[] updatedProductSelections?; +}; + +public type ReviewCreatedMessagePayload record { + *MessagePayload; + string 'type?; + Review review?; +}; + +public type SyntaxErrorError record { + *ErrorObject; + string code?; + string message?; +}; + +public type CustomerEmailVerifiedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; +}; + +public type CartDiscount record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + LocalizedString name?; + string 'key?; + LocalizedString description?; + CartDiscountValue value?; + string cartPredicate?; + CartDiscountTarget target?; + string sortOrder?; + boolean isActive?; + string validFrom?; + string validUntil?; + boolean requiresDiscountCode?; + Reference[] references?; + StackingMode stackingMode?; + CustomFields custom?; +}; + +public type MyCartUpdate record { + int 'version?; + MyCartUpdateAction[] actions?; +}; + +public type ParcelAddedToDeliveryMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Delivery delivery?; + Parcel parcel?; +}; + +public type InternalConstraintViolatedError record { + *ErrorObject; + string code?; + string message?; +}; + +public type ProductTypeSetInputTipAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + LocalizedString inputTip?; +}; + +public type OrderEditSetCommentAction record { + *OrderEditUpdateAction; + string action?; + string comment?; +}; + +public type SubscriptionUpdateAction record { + string action?; +}; + +public type AttributeDateTimeType record { + *AttributeType; + string name?; +}; + +public type DiscountCodeSetCartPredicateAction record { + *DiscountCodeUpdateAction; + string action?; + string cartPredicate?; +}; + +public type ShippingMethodRemoveShippingRateAction record { + *ShippingMethodUpdateAction; + string action?; + ZoneResourceIdentifier zone?; + ShippingRateDraft shippingRate?; +}; + +public type ProductSetAssetDescriptionAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; + string assetId?; + string assetKey?; + LocalizedString description?; +}; + +public type DeliveryCloudEventsFormat record { + *DeliveryFormat; + string 'type?; + string cloudEventsVersion?; +}; + +public type CustomFieldMoneyType record { + *FieldType; + string name?; +}; + +public type PaymentCreatedMessagePayload record { + *MessagePayload; + string 'type?; + Payment payment?; +}; + +public type ProjectChangeProductSearchIndexingEnabledAction record { + *ProjectUpdateAction; + string action?; + boolean enabled?; +}; + +public type CustomerAddressAddedMessagePayload record { + *MessagePayload; + string 'type?; + Address address?; +}; + +public type OrderRemovePaymentAction record { + *OrderUpdateAction; + string action?; + PaymentResourceIdentifier payment?; +}; + +public type StoreUpdate record { + int 'version?; + StoreUpdateAction[] actions?; +}; + +public type CustomerSetVatIdAction record { + *CustomerUpdateAction; + string action?; + string vatId?; +}; + +public type MyPaymentDraft record { + Money amountPlanned?; + PaymentMethodInfo paymentMethodInfo?; + CustomFieldsDraft custom?; + MyTransactionDraft 'transaction?; +}; + +public type CategoryDraft record { + LocalizedString name?; + LocalizedString slug?; + LocalizedString description?; + CategoryResourceIdentifier parent?; + string orderHint?; + string externalId?; + LocalizedString metaTitle?; + LocalizedString metaDescription?; + LocalizedString metaKeywords?; + CustomFieldsDraft custom?; + AssetDraft[] assets?; + string 'key?; +}; + +public type CustomerAddressChangedMessagePayload record { + *MessagePayload; + string 'type?; + Address address?; +}; + +public type CustomerChangePassword record { + string id?; + int 'version?; + string currentPassword?; + string newPassword?; +}; + +public type OrderShippingRateInputSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ShippingRateInput shippingRateInput?; + ShippingRateInput oldShippingRateInput?; +}; + +public type ProjectChangeNameAction record { + *ProjectUpdateAction; + string action?; + string name?; +}; + +public type ReviewStateTransitionMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + StateReference oldState?; + StateReference newState?; + boolean oldIncludedInStatistics?; + boolean newIncludedInStatistics?; + Reference target?; + boolean force?; +}; + +public type MyCustomerSetCustomFieldAction record { + *MyCustomerUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ProductSelectionSetting record { + ProductSelectionReference productSelection?; + boolean active?; +}; + +public type StagedOrderAddItemShippingAddressAction record { + *StagedOrderUpdateAction; + string action?; + BaseAddress address?; +}; + +public type KeyReference record { + ReferenceTypeId typeId?; + string 'key?; +}; + +public type TypeChangeNameAction record { + *TypeUpdateAction; + string action?; + LocalizedString name?; +}; + +public type SearchIndexingConfiguration record { + SearchIndexingConfigurationValues products?; + SearchIndexingConfigurationValues orders?; +}; + +public type StorePagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Store[] results?; +}; + +public type CustomerDateOfBirthSetMessagePayload record { + *MessagePayload; + string 'type?; + string dateOfBirth?; +}; + +public type StagedOrderSetLineItemDistributionChannelAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + ChannelResourceIdentifier distributionChannel?; +}; + +public type DeliveryRemovedMessagePayload record { + *MessagePayload; + string 'type?; + Delivery delivery?; +}; + +public type TaxCalculationMode string; + +public type SearchDeactivatedError record { + *ErrorObject; + string code?; + string message?; +}; + +public type ProductAddedToCategoryMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + CategoryReference category?; + boolean staged?; +}; + +public type MyShoppingListSetDescriptionAction record { + *MyShoppingListUpdateAction; + string action?; + LocalizedString description?; +}; + +public type OrderShippingInfoSetMessagePayload record { + *MessagePayload; + string 'type?; + ShippingInfo shippingInfo?; + ShippingInfo oldShippingInfo?; +}; + +public type SuggestionResult record { +}; + +public type ShoppingListSetCustomFieldAction record { + *ShoppingListUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ProductDiscountValueAbsoluteDraft record { + *ProductDiscountValueDraft; + string 'type?; + Money[] money?; +}; + +public type MultiBuyCustomLineItemsTarget record { + *CartDiscountTarget; + string 'type?; + string predicate?; + int triggerQuantity?; + int discountedQuantity?; + int maxOccurrence?; + SelectionMode selectionMode?; +}; + +public type Sort string; + +public type ShippingInfo record { + string shippingMethodName?; + TypedMoney price?; + ShippingRate shippingRate?; + TaxedItemPrice taxedPrice?; + TaxRate taxRate?; + TaxCategoryReference taxCategory?; + ShippingMethodReference shippingMethod?; + Delivery[] deliveries?; + DiscountedLineItemPrice discountedPrice?; + ShippingMethodState shippingMethodState?; +}; + +public type CartSetCustomTypeAction record { + *CartUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ExtensionTrigger record { + ExtensionResourceTypeId resourceTypeId?; + ExtensionAction[] actions?; +}; + +public type StagedOrderAddCustomLineItemAction record { + *StagedOrderUpdateAction; + string action?; + Money money?; + LocalizedString name?; + float quantity?; + string slug?; + TaxCategoryResourceIdentifier taxCategory?; + CustomFieldsDraft custom?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type ShoppingListSetCustomerAction record { + *ShoppingListUpdateAction; + string action?; + CustomerResourceIdentifier customer?; +}; + +public type ExternalTaxRateDraft record { + string name?; + float amount?; + string country?; + string state?; + SubRate[] subRates?; + boolean includedInPrice?; +}; + +public type StagedOrderSetCustomLineItemTaxAmountAction record { + *StagedOrderUpdateAction; + string action?; + string customLineItemId?; + ExternalTaxAmountDraft externalTaxAmount?; +}; + +public type CartDiscountChangeStackingModeAction record { + *CartDiscountUpdateAction; + string action?; + StackingMode stackingMode?; +}; + +public type PriceTierDraft record { + int minimumQuantity?; + Money value?; +}; + +public type MaxResourceLimitExceededError record { + *ErrorObject; + string code?; + string message?; + ReferenceTypeId exceededResource?; +}; + +public type MyShoppingListSetLineItemCustomTypeAction record { + *MyShoppingListUpdateAction; + string action?; + string lineItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type StagedOrderSetParcelMeasurementsAction record { + *StagedOrderUpdateAction; + string action?; + string parcelId?; + ParcelMeasurements measurements?; +}; + +public type CustomerResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type MyCustomerRemoveBillingAddressIdAction record { + *MyCustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type ProductDiscountUpdate record { + int 'version?; + ProductDiscountUpdateAction[] actions?; +}; + +public type CustomerGroupUpdate record { + int 'version?; + CustomerGroupUpdateAction[] actions?; +}; + +public type CustomerSetStoresAction record { + *CustomerUpdateAction; + string action?; + StoreResourceIdentifier[] stores?; +}; + +public type ShoppingListChangeNameAction record { + *ShoppingListUpdateAction; + string action?; + LocalizedString name?; +}; + +public type MyCustomerSetDateOfBirthAction record { + *MyCustomerUpdateAction; + string action?; + string dateOfBirth?; +}; + +public type TypeAddLocalizedEnumValueAction record { + *TypeUpdateAction; + string action?; + string fieldName?; + CustomFieldLocalizedEnumValue value?; +}; + +public type SubscriptionSetKeyAction record { + *SubscriptionUpdateAction; + string action?; + string 'key?; +}; + +public type Transaction record { + string id?; + string timestamp?; + TransactionType 'type?; + TypedMoney amount?; + string interactionId?; + TransactionState state?; + CustomFields custom?; +}; + +public type PaymentSetAmountPaidAction record { + *PaymentUpdateAction; + string action?; + Money amount?; +}; + +public type AssignedProductReference record { + ProductReference product?; +}; + +public type StagedOrderSetShippingMethodTaxRateAction record { + *StagedOrderUpdateAction; + string action?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type ProductSelectionChangeNameAction record { + *ProductSelectionUpdateAction; + string action?; + LocalizedString name?; +}; + +public type TypeUpdateAction record { + string action?; +}; + +public type OverCapacityError record { + *ErrorObject; + string code?; + string message?; +}; + +public type CartSetCountryAction record { + *CartUpdateAction; + string action?; + CountryCode country?; +}; + +public type ShippingRate record { + TypedMoney price?; + TypedMoney freeAbove?; + boolean isMatching?; + ShippingRatePriceTier[] tiers?; +}; + +public type CartSetCartTotalTaxAction record { + *CartUpdateAction; + string action?; + Money externalTotalGross?; + TaxPortionDraft[] externalTaxPortions?; +}; + +public type ProductRemoveAssetAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; + string assetId?; + string assetKey?; +}; + +public type CustomerPasswordUpdatedMessagePayload record { + *MessagePayload; + string 'type?; + boolean reset?; +}; + +public type StagedOrderChangeTaxRoundingModeAction record { + *StagedOrderUpdateAction; + string action?; + RoundingMode taxRoundingMode?; +}; + +public type BadGatewayError record { + *ErrorObject; + string code?; + string message?; +}; + +public type PaymentState string; + +public type ShippingRatePriceTier record { + ShippingRateTierType 'type?; +}; + +public type GeoJson record { + string 'type?; +}; + +public type SubscriptionUpdate record { + int 'version?; + SubscriptionUpdateAction[] actions?; +}; + +public type StagedOrderUpdateItemShippingAddressAction record { + *StagedOrderUpdateAction; + string action?; + BaseAddress address?; +}; + +public type WeakPasswordError record { + *ErrorObject; + string code?; + string message?; +}; + +public type OrderSetReturnPaymentStateAction record { + *OrderUpdateAction; + string action?; + string returnItemId?; + ReturnPaymentState paymentState?; +}; + +public type OrderPagedSearchResponse record { + int total?; + int offset?; + int 'limit?; + Hit[] hits?; +}; + +public type CustomerFirstNameSetMessagePayload record { + *MessagePayload; + string 'type?; + string firstName?; +}; + +public type StagedOrderAddParcelToDeliveryAction record { + *StagedOrderUpdateAction; + string action?; + string deliveryId?; + ParcelMeasurements measurements?; + TrackingData trackingData?; + DeliveryItem[] items?; +}; + +public type ParcelRemovedFromDeliveryMessagePayload record { + *MessagePayload; + string 'type?; + string deliveryId?; + Parcel parcel?; +}; + +public type ProductSetMetaDescriptionAction record { + *ProductUpdateAction; + string action?; + LocalizedString metaDescription?; + boolean staged?; +}; + +public type OrderReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + Order obj?; +}; + +public type SearchFacetPathNotFoundError record { + *ErrorObject; + string code?; + string message?; +}; + +public type EditPreviewFailedError record { + *ErrorObject; + string code?; + string message?; + OrderEditPreviewFailure result?; +}; + +public type ShoppingListChangeLineItemQuantityAction record { + *ShoppingListUpdateAction; + string action?; + string lineItemId?; + int quantity?; +}; + +public type ProductSelectionProductAddedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ProductReference product?; +}; + +public type ShoppingListPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + ShoppingList[] results?; +}; + +public type CategorySetAssetDescriptionAction record { + *CategoryUpdateAction; + string action?; + string assetId?; + string assetKey?; + LocalizedString description?; +}; + +public type MyCustomerChangeEmailAction record { + *MyCustomerUpdateAction; + string action?; + string email?; +}; + +public type ParcelMeasurementsUpdatedMessagePayload record { + *MessagePayload; + string 'type?; + string deliveryId?; + string parcelId?; + ParcelMeasurements measurements?; +}; + +public type TaxCategoryUpdateAction record { + string action?; +}; + +public type ClientLogging record { + string clientId?; + string externalUserId?; + CustomerReference customer?; + string anonymousId?; +}; + +public type StoreSetNameAction record { + *StoreUpdateAction; + string action?; + LocalizedString name?; +}; + +public type ProjectUpdateAction record { + string action?; +}; + +public type TaxCategorySetKeyAction record { + *TaxCategoryUpdateAction; + string action?; + string 'key?; +}; + +public type TypeUpdate record { + int 'version?; + TypeUpdateAction[] actions?; +}; + +public type CartReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + Cart obj?; +}; + +public type StateRoleEnum string; + +public type ProductSelectionType record { + ProductSelectionTypeEnum 'type?; +}; + +public type TypedMoneyDraft record { + *Money; + int centAmount?; + CurrencyCode currencyCode?; + MoneyType 'type?; + int fractionDigits?; +}; + +public type CustomerSetKeyAction record { + *CustomerUpdateAction; + string action?; + string 'key?; +}; + +public type ProductAddVariantAction record { + *ProductUpdateAction; + string action?; + string sku?; + string 'key?; + PriceDraft[] prices?; + Image[] images?; + Attribute[] attributes?; + boolean staged?; + Asset[] assets?; +}; + +public type CartSetDeliveryAddressCustomTypeAction record { + *CartUpdateAction; + string action?; + string deliveryId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type InvalidTokenError record { + *ErrorObject; + string code?; + string message?; +}; + +public type ProductTypeSetKeyAction record { + *ProductTypeUpdateAction; + string action?; + string 'key?; +}; + +public type ProjectSetExternalOAuthAction record { + *ProjectUpdateAction; + string action?; + ExternalOAuth externalOAuth?; +}; + +public type ProductTypeAddLocalizedEnumValueAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + AttributeLocalizedEnumValue value?; +}; + +public type CustomerSetFirstNameAction record { + *CustomerUpdateAction; + string action?; + string firstName?; +}; + +public type ProductDiscountSetValidUntilAction record { + *ProductDiscountUpdateAction; + string action?; + string validUntil?; +}; + +public type ParcelTrackingDataUpdatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string deliveryId?; + string parcelId?; + TrackingData trackingData?; +}; + +public type DuplicatePriceScopeError record { + *ErrorObject; + string code?; + string message?; + Price[] conflictingPrices?; +}; + +public type OrderLineItemAddedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + LineItem lineItem?; + int addedQuantity?; +}; + +public type OrderSetDeliveryAddressCustomTypeAction record { + *OrderUpdateAction; + string action?; + string deliveryId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type StagedOrderSetLineItemCustomTypeAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type InventoryEntrySetCustomTypeAction record { + *InventoryEntryUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type FacetResultTerm record { + string|record {}|string[]|decimal|int|boolean term?; + int count?; + int productCount?; +}; + +public type ProductVariantDraft record { + string sku?; + string 'key?; + PriceDraft[] prices?; + Attribute[] attributes?; + Image[] images?; + AssetDraft[] assets?; +}; + +public type ProductSetImageLabelAction record { + *ProductUpdateAction; + string action?; + string sku?; + int variantId?; + string imageUrl?; + string label?; + boolean staged?; +}; + +public type AttributeDefinitionTypeConflictError record { + *ErrorObject; + string code?; + string message?; + string conflictingProductTypeId?; + string conflictingProductTypeName?; + string conflictingAttributeName?; +}; + +public type ReviewSetKeyAction record { + *ReviewUpdateAction; + string action?; + string 'key?; +}; + +public type InsufficientScopeError record { + *ErrorObject; + string code?; + string message?; +}; + +public type InventoryEntryChangeQuantityAction record { + *InventoryEntryUpdateAction; + string action?; + int quantity?; +}; + +public type CustomerTitleSetMessagePayload record { + *MessagePayload; + string 'type?; + string title?; +}; + +public type SemanticErrorError record { + *ErrorObject; + string code?; + string message?; +}; + +public type AttributeEnumType record { + *AttributeType; + string name?; + AttributePlainEnumValue[] values?; +}; + +public type ParcelDraft record { + ParcelMeasurements measurements?; + TrackingData trackingData?; + DeliveryItem[] items?; + CustomFieldsDraft custom?; +}; + +public type PriceTier record { + int minimumQuantity?; + TypedMoney value?; +}; + +public type AttributeLocalizableTextType record { + *AttributeType; + string name?; +}; + +public type MyShoppingListChangeTextLineItemsOrderAction record { + *MyShoppingListUpdateAction; + string action?; + string[] textLineItemOrder?; +}; + +public type SyncInfo record { + ChannelReference 'channel?; + string externalId?; + string syncedAt?; +}; + +public type ProductDiscountMatchQuery record { + string productId?; + int variantId?; + boolean staged?; + QueryPrice price?; +}; + +public type StoreRemoveProductSelectionAction record { + *StoreUpdateAction; + string action?; + ResourceIdentifier productSelection?; +}; + +public type CartDiscountValueRelative record { + *CartDiscountValue; + string 'type?; + int permyriad?; +}; + +public type OrderSetParcelTrackingDataAction record { + *OrderUpdateAction; + string action?; + string parcelId?; + TrackingData trackingData?; +}; + +public type ProductSelectionDraft record { + string 'key?; + LocalizedString name?; +}; + +public type CustomerDraft record { + string customerNumber?; + string email?; + string password?; + string firstName?; + string lastName?; + string middleName?; + string title?; + string anonymousCartId?; + CartResourceIdentifier anonymousCart?; + string anonymousId?; + string dateOfBirth?; + string companyName?; + string vatId?; + BaseAddress[] addresses?; + int defaultShippingAddress?; + int[] shippingAddresses?; + int defaultBillingAddress?; + int[] billingAddresses?; + boolean isEmailVerified?; + string externalId?; + CustomerGroupResourceIdentifier customerGroup?; + CustomFieldsDraft custom?; + string locale?; + string salutation?; + string 'key?; + StoreResourceIdentifier[] stores?; +}; + +public type AddressDraft record { + *BaseAddress; + string id?; + string 'key?; + string title?; + string salutation?; + string firstName?; + string lastName?; + string streetName?; + string streetNumber?; + string additionalStreetInfo?; + string postalCode?; + string city?; + string region?; + string state?; + CountryCode country?; + string company?; + string department?; + string building?; + string apartment?; + string pOBox?; + string phone?; + string mobile?; + string email?; + string fax?; + string additionalAddressInfo?; + string externalId?; + CustomFieldsDraft custom?; +}; + +public type StateChangeTypeAction record { + *StateUpdateAction; + string action?; + StateTypeEnum 'type?; +}; + +public type ShippingRateInputDraft record { + string 'type?; +}; + +public type Parcel record { + string id?; + string createdAt?; + ParcelMeasurements measurements?; + TrackingData trackingData?; + DeliveryItem[] items?; + CustomFields custom?; +}; + +public type OrderReturnInfoAddedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ReturnInfo returnInfo?; +}; + +public type ProductType record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + string name?; + string description?; + AttributeDefinition[] attributes?; +}; + +public type Project record { + int 'version?; + string 'key?; + string name?; + CountryCode[] countries?; + CurrencyCode[] currencies?; + Locale[] languages?; + string createdAt?; + string trialUntil?; + MessageConfiguration messages?; + ShippingRateInputType shippingRateInputType?; + ExternalOAuth externalOAuth?; + CartsConfiguration carts?; + SearchIndexingConfiguration searchIndexing?; + ShoppingListsConfiguration shoppingLists?; +}; + +public type ShippingRateInputType record { + ShippingRateTierType 'type?; +}; + +public type ZoneChangeNameAction record { + *ZoneUpdateAction; + string action?; + string name?; +}; + +public type CustomerReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + Customer obj?; +}; + +public type ProductDiscountValueRelative record { + *ProductDiscountValue; + string 'type?; + int permyriad?; +}; + +public type MyCartUpdateAction record { + string action?; +}; + +public type StagedOrderTransitionCustomLineItemStateAction record { + *StagedOrderUpdateAction; + string action?; + string customLineItemId?; + int quantity?; + StateResourceIdentifier fromState?; + StateResourceIdentifier toState?; + string actualTransitionDate?; +}; + +public type TaxedItemPrice record { + TypedMoney totalNet?; + TypedMoney totalGross?; +}; + +public type OrderPaymentAddedMessagePayload record { + *MessagePayload; + string 'type?; + PaymentReference payment?; +}; + +public type ItemState record { + float quantity?; + StateReference state?; +}; + +public type CustomerSetDefaultShippingAddressAction record { + *CustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type ProductChangeAssetNameAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; + string assetId?; + string assetKey?; + LocalizedString name?; +}; + +public type ShoppingListLineItemDraft record { + string addedAt?; + CustomFieldsDraft custom?; + string sku?; + string productId?; + int quantity?; + int variantId?; +}; + +public type StagedOrderSetDeliveryCustomFieldAction record { + *StagedOrderUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ProductSelectionUpdateAction record { + string action?; +}; + +public type AttributeDefinitionAlreadyExistsError record { + *ErrorObject; + string code?; + string message?; + string conflictingProductTypeId?; + string conflictingProductTypeName?; + string conflictingAttributeName?; +}; + +public type InventoryEntryCreatedMessagePayload record { + *MessagePayload; + string 'type?; + InventoryEntry inventoryEntry?; +}; + +public type ProductSelectionProductRemovedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ProductReference product?; +}; + +public type Attribute record { + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type OrderPaymentStateChangedMessagePayload record { + *MessagePayload; + string 'type?; + PaymentState paymentState?; + PaymentState oldPaymentState?; +}; + +public type CustomerRemoveBillingAddressIdAction record { + *CustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type StagedOrderRemoveCustomLineItemAction record { + *StagedOrderUpdateAction; + string action?; + string customLineItemId?; +}; + +public type OrderAddItemShippingAddressAction record { + *OrderUpdateAction; + string action?; + BaseAddress address?; +}; + +public type MyCartSetShippingMethodAction record { + *MyCartUpdateAction; + string action?; + ShippingMethodResourceIdentifier shippingMethod?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type OrderEdit record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + OrderReference 'resource?; + StagedOrderUpdateAction[] stagedActions?; + CustomFields custom?; + OrderEditResult result?; + string comment?; +}; + +public type ProductCreatedMessagePayload record { + *MessagePayload; + string 'type?; + ProductProjection productProjection?; +}; + +public type SubscriptionPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Subscription[] results?; +}; + +public type CustomLineItemImportDraft record { + LocalizedString name?; + int quantity?; + Money money?; + string slug?; + ItemState[] state?; + TaxRate taxRate?; + TaxCategoryResourceIdentifier taxCategory?; + CustomFieldsDraft custom?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type StagedOrderRemoveLineItemAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + float quantity?; + Money externalPrice?; + ExternalLineItemTotalPrice externalTotalPrice?; + ItemShippingDetailsDraft shippingDetailsToRemove?; +}; + +public type CustomerGroupReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + CustomerGroup obj?; +}; + +public type MyCustomerRemoveShippingAddressIdAction record { + *MyCustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type PaymentUpdate record { + int 'version?; + PaymentUpdateAction[] actions?; +}; + +public type TrackingData record { + string trackingId?; + string carrier?; + string provider?; + string providerTransaction?; + boolean isReturn?; +}; + +public type CartDiscountShippingCostTarget record { + *CartDiscountTarget; + string 'type?; +}; + +public type TypeReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + Type obj?; +}; + +public type CustomerSetCustomerGroupAction record { + *CustomerUpdateAction; + string action?; + CustomerGroupResourceIdentifier customerGroup?; +}; + +public type OrderUpdateItemShippingAddressAction record { + *OrderUpdateAction; + string action?; + BaseAddress address?; +}; + +public type ProjectChangeCurrenciesAction record { + *ProjectUpdateAction; + string action?; + CurrencyCode[] currencies?; +}; + +public type ShippingMethodSetLocalizedNameAction record { + *ShippingMethodUpdateAction; + string action?; + LocalizedString localizedName?; +}; + +public type ShoppingListChangeTextLineItemNameAction record { + *ShoppingListUpdateAction; + string action?; + string textLineItemId?; + LocalizedString name?; +}; + +public type OrderCustomerSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + CustomerReference customer?; + CustomerGroupReference customerGroup?; + CustomerReference oldCustomer?; + CustomerGroupReference oldCustomerGroup?; +}; + +public type StoreCreatedMessagePayload record { + *MessagePayload; + string 'type?; + LocalizedString name?; + string[] languages?; + ChannelReference[] distributionChannels?; + ChannelReference[] supplyChannels?; + ProductSelectionSetting[] productSelections?; + CustomFields custom?; +}; + +public type CartSetItemShippingAddressCustomFieldAction record { + *CartUpdateAction; + string action?; + string addressKey?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ChannelAddRolesAction record { + *ChannelUpdateAction; + string action?; + ChannelRoleEnum[] roles?; +}; + +public type OrderSearchRequest record { + OrderSearchQuery query?; + OrderSearchSorting sort?; + int 'limit?; + int offset?; +}; + +public type OrderCreatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Order 'order?; +}; + +public type ReferenceTypeId string; + +public type DiscountedPriceDraft record { + Money value?; + ProductDiscountReference discount?; +}; + +public type DiscountCodePagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + DiscountCode[] results?; +}; + +public type DuplicateVariantValuesError record { + *ErrorObject; + string code?; + string message?; + VariantValues variantValues?; +}; + +public type VariantValues record { + string sku?; + PriceDraft[] prices?; + Attribute[] attributes?; +}; + +public type MyShoppingListSetCustomTypeAction record { + *MyShoppingListUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ProductSelectionSettingDraft record { + ProductSelectionResourceIdentifier productSelection?; + boolean active?; +}; + +public type StoreSetLanguagesAction record { + *StoreUpdateAction; + string action?; + string[] languages?; +}; + +public type OrderEditUpdate record { + int 'version?; + OrderEditUpdateAction[] actions?; + boolean dryRun?; +}; + +public type TypeChangeLabelAction record { + *TypeUpdateAction; + string action?; + string fieldName?; + LocalizedString label?; +}; + +public type InventoryEntrySetRestockableInDaysAction record { + *InventoryEntryUpdateAction; + string action?; + int restockableInDays?; +}; + +public type CartChangeTaxCalculationModeAction record { + *CartUpdateAction; + string action?; + TaxCalculationMode taxCalculationMode?; +}; + +public type QueryPrice record { + string id?; + Money value?; + CountryCode country?; + CustomerGroupReference customerGroup?; + ChannelReference 'channel?; + string validFrom?; + string validUntil?; + DiscountedPriceDraft discounted?; + CustomFields custom?; + PriceTierDraft[] tiers?; +}; + +public type TypedMoney record { + MoneyType 'type?; + int fractionDigits?; + int centAmount?; + CurrencyCode currencyCode?; +}; + +public type AnonymousCartSignInMode string; + +public type CustomFieldsDraft record { + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type CustomerRemoveStoreAction record { + *CustomerUpdateAction; + string action?; + StoreResourceIdentifier store?; +}; + +public type OrderEditSetCustomTypeAction record { + *OrderEditUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + record {} fields?; +}; + +public type CartSetLineItemSupplyChannelAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + ChannelResourceIdentifier supplyChannel?; +}; + +public type AttributeValue string|record {}|string[]|decimal|int|boolean; + +public type ProductUpdate record { + int 'version?; + ProductUpdateAction[] actions?; +}; + +public type ReviewSetTextAction record { + *ReviewUpdateAction; + string action?; + string text?; +}; + +public type CustomerEmailChangedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string email?; +}; + +public type OrderSetDeliveryItemsAction record { + *OrderUpdateAction; + string action?; + string deliveryId?; + DeliveryItem[] items?; +}; + +public type ProductTypeChangeLocalizedEnumValueLabelAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + AttributeLocalizedEnumValue newValue?; +}; + +public type SubscriptionDraft record { + ChangeSubscription[] changes?; + Destination destination?; + string 'key?; + MessageSubscription[] messages?; + DeliveryFormat format?; +}; + +public type OrderSetLineItemCustomTypeAction record { + *OrderUpdateAction; + string action?; + string lineItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type TypeDraft record { + string 'key?; + LocalizedString name?; + LocalizedString description?; + ResourceTypeId[] resourceTypeIds?; + FieldDefinition[] fieldDefinitions?; +}; + +public type NotEnabledError record { + *ErrorObject; + string code?; + string message?; +}; + +public type GraphQLRequest record { + string query?; + string operationName?; + GraphQLVariablesMap variables?; +}; + +public type QueryTimedOutError record { + *ErrorObject; + string code?; + string message?; +}; + +public type CartDiscountChangeTargetAction record { + *CartDiscountUpdateAction; + string action?; + CartDiscountTarget target?; +}; + +public type CategorySetAssetTagsAction record { + *CategoryUpdateAction; + string action?; + string assetId?; + string assetKey?; + string[] tags?; +}; + +public type CartAddPaymentAction record { + *CartUpdateAction; + string action?; + PaymentResourceIdentifier payment?; +}; + +public type ProjectChangeCartsConfigurationAction record { + *ProjectUpdateAction; + string action?; + CartsConfiguration cartsConfiguration?; +}; + +public type ShippingMethodAddZoneAction record { + *ShippingMethodUpdateAction; + string action?; + ZoneResourceIdentifier zone?; +}; + +public type StagedOrderImportCustomLineItemStateAction record { + *StagedOrderUpdateAction; + string action?; + string customLineItemId?; + ItemState[] state?; +}; + +public type ExtensionResourceTypeId string; + +public type OrderSetReturnItemCustomFieldAction record { + *OrderUpdateAction; + string action?; + string returnItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type CartDiscountUpdate record { + int 'version?; + CartDiscountUpdateAction[] actions?; +}; + +public type CustomerLastNameSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string lastName?; +}; + +public type CartDiscountDraft record { + LocalizedString name?; + string 'key?; + LocalizedString description?; + CartDiscountValueDraft value?; + string cartPredicate?; + CartDiscountTarget target?; + string sortOrder?; + boolean isActive?; + string validFrom?; + string validUntil?; + boolean requiresDiscountCode?; + StackingMode stackingMode?; + CustomFieldsDraft custom?; +}; + +public type CategoryUpdate record { + int 'version?; + CategoryUpdateAction[] actions?; +}; + +public type DiscountedLineItemPrice record { + TypedMoney value?; + DiscountedLineItemPortion[] includedDiscounts?; +}; + +public type OrderEditUpdateAction record { + string action?; +}; + +public type OrderSetShippingAddressAction record { + *OrderUpdateAction; + string action?; + BaseAddress address?; +}; + +public type ProductDiscount record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + LocalizedString name?; + string 'key?; + LocalizedString description?; + ProductDiscountValue value?; + string predicate?; + string sortOrder?; + boolean isActive?; + Reference[] references?; + string validFrom?; + string validUntil?; +}; + +public type FacetResultRange record { + float 'from?; + string fromStr?; + float to?; + string toStr?; + int count?; + int productCount?; + float total?; + float min?; + float max?; + float mean?; +}; + +public type ProductChangeNameAction record { + *ProductUpdateAction; + string action?; + LocalizedString name?; + boolean staged?; +}; + +public type ProductRemovePriceAction record { + *ProductUpdateAction; + string action?; + string priceId?; + boolean staged?; +}; + +public type ApiClientPagedQueryResponse record { + int 'limit?; + int offset?; + int count?; + int total?; + ApiClient[] results?; +}; + +public type CartSetCustomLineItemCustomTypeAction record { + *CartUpdateAction; + string action?; + string customLineItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ParcelMeasurementsUpdatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string deliveryId?; + string parcelId?; + ParcelMeasurements measurements?; +}; + +public type SubscriptionHealthStatus string; + +public type OrderLineItemRemovedMessagePayload record { + *MessagePayload; + string 'type?; + string lineItemId?; + int removedQuantity?; + int newQuantity?; + ItemState[] newState?; + TypedMoney newTotalPrice?; + TaxedItemPrice newTaxedPrice?; + Price newPrice?; + ItemShippingDetails newShippingDetail?; +}; + +public type DiscountedLineItemPriceForQuantity record { + float quantity?; + DiscountedLineItemPrice discountedPrice?; +}; + +public type TaxPortion record { + string name?; + float rate?; + TypedMoney amount?; +}; + +public type CustomerPasswordUpdatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + boolean reset?; +}; + +public type AzureEventGridDestination record { + *Destination; + string 'type?; + string uri?; + string accessKey?; +}; + +public type ShippingRateTierType string; + +public type MoneyType string; + +public type StateChangeKeyAction record { + *StateUpdateAction; + string action?; + string 'key?; +}; + +public type ShippingMethodState string; + +public type CustomerAddressAddedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Address address?; +}; + +public type TermFacetResultType string; + +public type ShippingMethodDoesNotMatchCartError record { + *ErrorObject; + string code?; + string message?; +}; + +public type OrderSetBillingAddressCustomTypeAction record { + *OrderUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type StoreDeletedMessagePayload record { + *MessagePayload; + string 'type?; +}; + +public type StagedOrderSetCustomerGroupAction record { + *StagedOrderUpdateAction; + string action?; + CustomerGroupResourceIdentifier customerGroup?; +}; + +public type MyCartSetLocaleAction record { + *MyCartUpdateAction; + string action?; + string locale?; +}; + +public type ReviewSetCustomFieldAction record { + *ReviewUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type OrderSetReturnInfoAction record { + *OrderUpdateAction; + string action?; + ReturnInfoDraft[] items?; +}; + +public type Review record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + string uniquenessValue?; + string locale?; + string authorName?; + string title?; + string text?; + string|record {}|string[]|decimal|int|boolean target?; + boolean includedInStatistics?; + int rating?; + StateReference state?; + CustomerReference customer?; + CustomFields custom?; +}; + +public type StagedOrderChangeOrderStateAction record { + *StagedOrderUpdateAction; + string action?; + OrderState orderState?; +}; + +public type ReturnItemDraft record { + int quantity?; + string lineItemId?; + string customLineItemId?; + string comment?; + ReturnShipmentState shipmentState?; + CustomFieldsDraft custom?; +}; + +public type PaymentSetAnonymousIdAction record { + *PaymentUpdateAction; + string action?; + string anonymousId?; +}; + +public type FeatureRemovedError record { + *ErrorObject; + string code?; + string message?; +}; + +public type ParcelItemsUpdatedMessagePayload record { + *MessagePayload; + string 'type?; + string parcelId?; + string deliveryId?; + DeliveryItem[] items?; + DeliveryItem[] oldItems?; +}; + +public type OrderUpdateSyncInfoAction record { + *OrderUpdateAction; + string action?; + ChannelResourceIdentifier 'channel?; + string externalId?; + string syncedAt?; +}; + +public type ProductSlugChangedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + LocalizedString slug?; + LocalizedString oldSlug?; +}; + +public type PaymentTransactionStateChangedMessagePayload record { + *MessagePayload; + string 'type?; + string transactionId?; + TransactionState state?; +}; + +public type StagedOrderTransitionStateAction record { + *StagedOrderUpdateAction; + string action?; + StateResourceIdentifier state?; + boolean force?; +}; + +public type ProductDraft record { + ProductTypeResourceIdentifier productType?; + LocalizedString name?; + LocalizedString slug?; + string 'key?; + LocalizedString description?; + CategoryResourceIdentifier[] categories?; + CategoryOrderHints categoryOrderHints?; + LocalizedString metaTitle?; + LocalizedString metaDescription?; + LocalizedString metaKeywords?; + ProductVariantDraft masterVariant?; + ProductVariantDraft[] variants?; + TaxCategoryResourceIdentifier taxCategory?; + SearchKeywords searchKeywords?; + StateResourceIdentifier state?; + boolean publish?; +}; + +public type CartDiscountUpdateAction record { + string action?; +}; + +public type DiscountCodeSetValidFromAndUntilAction record { + *DiscountCodeUpdateAction; + string action?; + string validFrom?; + string validUntil?; +}; + +public type MyCustomerDraft record { + string email?; + string password?; + string firstName?; + string lastName?; + string middleName?; + string title?; + string dateOfBirth?; + string companyName?; + string vatId?; + BaseAddress[] addresses?; + int defaultShippingAddress?; + int defaultBillingAddress?; + CustomFields custom?; + string locale?; + StoreResourceIdentifier[] stores?; +}; + +public type ReviewPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Review[] results?; +}; + +public type CartChangeLineItemQuantityAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + int quantity?; + Money externalPrice?; + ExternalLineItemTotalPrice externalTotalPrice?; +}; + +public type StoreAddProductSelectionAction record { + *StoreUpdateAction; + string action?; + ProductSelectionSettingDraft productSelection?; +}; + +public type PaymentSetStatusInterfaceCodeAction record { + *PaymentUpdateAction; + string action?; + string interfaceCode?; +}; + +public type ContainerAndKey record { + string 'key?; + string container?; +}; + +public type ProductSelectionReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + ProductSelection obj?; +}; + +public type ShippingRateInput record { + string 'type?; +}; + +public type CustomerAddStoreAction record { + *CustomerUpdateAction; + string action?; + StoreResourceIdentifier store?; +}; + +public type TaxCategorySetDescriptionAction record { + *TaxCategoryUpdateAction; + string action?; + string description?; +}; + +public type ZoneAddLocationAction record { + *ZoneUpdateAction; + string action?; + Location location?; +}; + +public type CartClassificationType record { + *ShippingRateInputType; + ShippingRateTierType 'type?; + CustomFieldLocalizedEnumValue[] values?; +}; + +public type TaxCategoryReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + TaxCategory obj?; +}; + +public type StateUpdateAction record { + string action?; +}; + +public type ProductDiscountChangeValueAction record { + *ProductDiscountUpdateAction; + string action?; + ProductDiscountValueDraft value?; +}; + +public type ProjectSetShippingRateInputTypeAction record { + *ProjectUpdateAction; + string action?; + ShippingRateInputType shippingRateInputType?; +}; + +public type ChannelUpdateAction record { + string action?; +}; + +public type OrderSetCustomTypeAction record { + *OrderUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type StoreSetDistributionChannelsAction record { + *StoreUpdateAction; + string action?; + ChannelResourceIdentifier[] distributionChannels?; +}; + +public type MyCartRemovePaymentAction record { + *MyCartUpdateAction; + string action?; + PaymentResourceIdentifier payment?; +}; + +public type ProductSetProductPriceCustomFieldAction record { + *ProductUpdateAction; + string action?; + string priceId?; + boolean staged?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ShippingMethodChangeTaxCategoryAction record { + *ShippingMethodUpdateAction; + string action?; + TaxCategoryResourceIdentifier taxCategory?; +}; + +public type ProductTransitionStateAction record { + *ProductUpdateAction; + string action?; + StateResourceIdentifier state?; + boolean force?; +}; + +public type ReviewSetCustomerAction record { + *ReviewUpdateAction; + string action?; + CustomerResourceIdentifier customer?; +}; + +public type CustomFieldSetType record { + *FieldType; + string name?; + FieldType elementType?; +}; + +public type CategorySetMetaDescriptionAction record { + *CategoryUpdateAction; + string action?; + LocalizedString metaDescription?; +}; + +public type CartChangeTaxModeAction record { + *CartUpdateAction; + string action?; + TaxMode taxMode?; +}; + +public type CustomerSetAddressCustomTypeAction record { + *CustomerUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; + string addressId?; +}; + +public type DiscountCodeReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + DiscountCode obj?; +}; + +public type TransactionState string; + +public type ProductTypeChangePlainEnumValueOrderAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + AttributePlainEnumValue[] values?; +}; + +public type CustomerSetSalutationAction record { + *CustomerUpdateAction; + string action?; + string salutation?; +}; + +public type ReviewReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + Review obj?; +}; + +public type ShoppingListRemoveTextLineItemAction record { + *ShoppingListUpdateAction; + string action?; + string textLineItemId?; + int quantity?; +}; + +public type CustomerAddressRemovedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Address address?; +}; + +public type InvalidCurrentPasswordError record { + *ErrorObject; + string code?; + string message?; +}; + +public type ExtensionChangeTriggersAction record { + *ExtensionUpdateAction; + string action?; + ExtensionTrigger[] triggers?; +}; + +public type CartSetShippingAddressAction record { + *CartUpdateAction; + string action?; + BaseAddress address?; +}; + +public type AttributeConstraintEnumDraft string; + +public type AttributeLocalizedEnumValue record { + string 'key?; + LocalizedString label?; +}; + +public type CartUpdate record { + int 'version?; + CartUpdateAction[] actions?; +}; + +public type SearchIndexingConfigurationStatus string; + +public type MyPaymentSetTransactionCustomFieldAction record { + *MyPaymentUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type AttributeNameDoesNotExistError record { + *ErrorObject; + string code?; + string message?; + string invalidAttributeName?; +}; + +public type LanguageUsedInStoresError record { + *ErrorObject; + string code?; + string message?; +}; + +public type CartResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type StoreSetProductSelectionsAction record { + *StoreUpdateAction; + string action?; + ProductSelectionSettingDraft[] productSelections?; +}; + +public type OrderSetCustomerEmailAction record { + *OrderUpdateAction; + string action?; + string email?; +}; + +public type CartRemoveCustomLineItemAction record { + *CartUpdateAction; + string action?; + string customLineItemId?; +}; + +public type CartSetShippingMethodAction record { + *CartUpdateAction; + string action?; + ShippingMethodResourceIdentifier shippingMethod?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type Subscription record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + ChangeSubscription[] changes?; + Destination destination?; + string 'key?; + MessageSubscription[] messages?; + DeliveryFormat format?; + SubscriptionHealthStatus status?; +}; + +public type CustomFieldDateTimeType record { + *FieldType; + string name?; +}; + +public type ShoppingListAddLineItemAction record { + *ShoppingListUpdateAction; + string action?; + string sku?; + string productId?; + int variantId?; + int quantity?; + string addedAt?; + CustomFieldsDraft custom?; +}; + +public type CartSetShippingAddressCustomFieldAction record { + *CartUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type LineItemPriceMode string; + +public type CategorySlugChangedMessagePayload record { + *MessagePayload; + string 'type?; + LocalizedString slug?; + LocalizedString oldSlug?; +}; + +public type MyCartUpdateItemShippingAddressAction record { + *MyCartUpdateAction; + string action?; + BaseAddress address?; +}; + +public type StoreCreatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + LocalizedString name?; + string[] languages?; + ChannelReference[] distributionChannels?; + ChannelReference[] supplyChannels?; + ProductSelectionSetting[] productSelections?; + CustomFields custom?; +}; + +public type ProductDiscountValueDraft record { + string 'type?; +}; + +public type CustomLineItemStateTransitionMessagePayload record { + *MessagePayload; + string 'type?; + string customLineItemId?; + string transitionDate?; + int quantity?; + StateReference fromState?; + StateReference toState?; +}; + +public type ResourceNotFoundError record { + *ErrorObject; + string code?; + string message?; +}; + +public type PaymentSetTransactionCustomTypeAction record { + *PaymentUpdateAction; + string action?; + string transactionId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type CartChangeTaxRoundingModeAction record { + *CartUpdateAction; + string action?; + RoundingMode taxRoundingMode?; +}; + +public type CartSetLineItemShippingDetailsAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type ShoppingListStoreSetMessagePayload record { + *MessagePayload; + string 'type?; + StoreKeyReference store?; +}; + +public type OrderSetItemShippingAddressCustomTypeAction record { + *OrderUpdateAction; + string action?; + string addressKey?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ProductTypeResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type CartSetBillingAddressCustomFieldAction record { + *CartUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ProductStateTransitionMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + StateReference state?; + boolean force?; +}; + +public type StagedOrderChangeLineItemQuantityAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + float quantity?; + Money externalPrice?; + ExternalLineItemTotalPrice externalTotalPrice?; +}; + +public type GeoJsonPoint record { + *GeoJson; + string 'type?; + float[] coordinates?; +}; + +public type QueryComplexityLimitExceededError record { + *ErrorObject; + string code?; + string message?; +}; + +public type ReturnInfoDraft record { + ReturnItemDraft[] items?; + string returnTrackingId?; + string returnDate?; +}; + +public type InvalidSubjectError record { + *ErrorObject; + string code?; + string message?; +}; + +public type CartChangeCustomLineItemMoneyAction record { + *CartUpdateAction; + string action?; + string customLineItemId?; + Money money?; +}; + +public type StagedOrderAddDeliveryAction record { + *StagedOrderUpdateAction; + string action?; + DeliveryItem[] items?; + BaseAddress address?; + ParcelDraft[] parcels?; + CustomFields custom?; +}; + +public type StatePagedQueryResponse record { + int 'limit?; + int offset?; + int count?; + int total?; + State[] results?; +}; + +public type ProductRemovedFromCategoryMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + CategoryReference category?; + boolean staged?; +}; + +public type InventoryEntryRemoveQuantityAction record { + *InventoryEntryUpdateAction; + string action?; + int quantity?; +}; + +public type CustomerTitleSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string title?; +}; + +public type ProductSelectionTypeEnum string; + +public type PriceChangedError record { + *ErrorObject; + string code?; + string message?; + string[] lineItems?; + boolean shipping?; +}; + +public type ProductSetAssetKeyAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; + string assetId?; + string assetKey?; +}; + +public type CustomerSetLastNameAction record { + *CustomerUpdateAction; + string action?; + string lastName?; +}; + +public type MyCartSetCustomFieldAction record { + *MyCartUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type PaymentResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type MultiBuyLineItemsTarget record { + *CartDiscountTarget; + string 'type?; + string predicate?; + int triggerQuantity?; + int discountedQuantity?; + int maxOccurrence?; + SelectionMode selectionMode?; +}; + +public type CustomFieldTimeType record { + *FieldType; + string name?; +}; + +public type InventoryEntrySetCustomFieldAction record { + *InventoryEntryUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type CategoryCreatedMessagePayload record { + *MessagePayload; + string 'type?; + Category category?; +}; + +public type OrderCustomerGroupSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + CustomerGroupReference customerGroup?; + CustomerGroupReference oldCustomerGroup?; +}; + +public type CustomerPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Customer[] results?; +}; + +public type StagedOrderUpdateSyncInfoAction record { + *StagedOrderUpdateAction; + string action?; + ChannelResourceIdentifier 'channel?; + string externalId?; + string syncedAt?; +}; + +public type AttributeTextType record { + *AttributeType; + string name?; +}; + +public type CustomerEmailVerifiedMessagePayload record { + *MessagePayload; + string 'type?; +}; + +public type ProductSelectionAssignment record { + ProductReference product?; + ProductSelectionReference productSelection?; +}; + +public type FieldContainer record { +}; + +public type ProductData record { + LocalizedString name?; + CategoryReference[] categories?; + CategoryOrderHints categoryOrderHints?; + LocalizedString description?; + LocalizedString slug?; + LocalizedString metaTitle?; + LocalizedString metaDescription?; + LocalizedString metaKeywords?; + ProductVariant masterVariant?; + ProductVariant[] variants?; + SearchKeywords searchKeywords?; +}; + +public type PaymentStatusDraft record { + string interfaceCode?; + string interfaceText?; + StateResourceIdentifier state?; +}; + +public type TypeChangeEnumValueLabelAction record { + *TypeUpdateAction; + string action?; + string fieldName?; + CustomFieldEnumValue value?; +}; + +public type OrderPaymentAddedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + PaymentReference payment?; +}; + +public type OrderRemoveDeliveryAction record { + *OrderUpdateAction; + string action?; + string deliveryId?; +}; + +public type CustomerGroupSetCustomTypeAction record { + *CustomerGroupUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ShoppingListUpdateAction record { + string action?; +}; + +public type TaxRateDraft record { + string name?; + float amount?; + boolean includedInPrice?; + CountryCode country?; + string state?; + SubRate[] subRates?; +}; + +public type CartValueType record { + *ShippingRateInputType; + ShippingRateTierType 'type?; +}; + +public type ChannelChangeDescriptionAction record { + *ChannelUpdateAction; + string action?; + LocalizedString description?; +}; + +public type PaymentMethodInfo record { + string paymentInterface?; + string method?; + LocalizedString name?; +}; + +public type CartAddLineItemAction record { + *CartUpdateAction; + string action?; + CustomFieldsDraft custom?; + ChannelResourceIdentifier distributionChannel?; + ExternalTaxRateDraft externalTaxRate?; + string productId?; + int variantId?; + string sku?; + int quantity?; + ChannelResourceIdentifier supplyChannel?; + Money externalPrice?; + ExternalLineItemTotalPrice externalTotalPrice?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type MyPaymentSetMethodInfoMethodAction record { + *MyPaymentUpdateAction; + string action?; + string method?; +}; + +public type ProductSelectionUpdate record { + int 'version?; + ProductSelectionUpdateAction[] actions?; +}; + +public type Hit record { + string id?; + int 'version?; + float relevance?; +}; + +public type Type record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + LocalizedString name?; + LocalizedString description?; + ResourceTypeId[] resourceTypeIds?; + FieldDefinition[] fieldDefinitions?; +}; + +public type MyCartRemoveDiscountCodeAction record { + *MyCartUpdateAction; + string action?; + DiscountCodeReference discountCode?; +}; + +public type ProductSetAssetCustomTypeAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; + string assetId?; + string assetKey?; + TypeResourceIdentifier 'type?; + record {} fields?; +}; + +public type OrderChangeShipmentStateAction record { + *OrderUpdateAction; + string action?; + ShipmentState shipmentState?; +}; + +public type OrderSetShippingAddressCustomFieldAction record { + *OrderUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type StagedOrderSetCustomShippingMethodAction record { + *StagedOrderUpdateAction; + string action?; + string shippingMethodName?; + ShippingRateDraft shippingRate?; + TaxCategoryResourceIdentifier taxCategory?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type CartSetShippingRateInputAction record { + *CartUpdateAction; + string action?; + ShippingRateInputDraft shippingRateInput?; +}; + +public type ParcelRemovedFromDeliveryMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string deliveryId?; + Parcel parcel?; +}; + +public type InventoryEntryResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type CustomerGroupUpdateAction record { + string action?; +}; + +public type DiscountCodeChangeIsActiveAction record { + *DiscountCodeUpdateAction; + string action?; + boolean isActive?; +}; + +public type ProductTypeChangeDescriptionAction record { + *ProductTypeUpdateAction; + string action?; + string description?; +}; + +public type RoundingMode string; + +public type StagedOrderSetCustomLineItemCustomFieldAction record { + *StagedOrderUpdateAction; + string action?; + string customLineItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type FieldDefinition record { + FieldType 'type?; + string name?; + LocalizedString label?; + boolean required?; + TypeTextInputHint inputHint?; +}; + +public type CartDiscountChangeRequiresDiscountCodeAction record { + *CartDiscountUpdateAction; + string action?; + boolean requiresDiscountCode?; +}; + +public type StagedOrderSetLineItemTaxAmountAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + ExternalTaxAmountDraft externalTaxAmount?; +}; + +public type Update record { + int 'version?; + UpdateAction[] actions?; +}; + +public type OrderLineItemAddedMessagePayload record { + *MessagePayload; + string 'type?; + LineItem lineItem?; + int addedQuantity?; +}; + +public type MyCustomerChangePassword record { + int 'version?; + string currentPassword?; + string newPassword?; +}; + +public type AccessDeniedError record { + *ErrorObject; + string code?; + string message?; +}; + +public type ReviewCreatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Review review?; +}; + +public type StagedOrderSetDeliveryCustomTypeAction record { + *StagedOrderUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + record {} fields?; +}; + +public type ChannelRemoveRolesAction record { + *ChannelUpdateAction; + string action?; + ChannelRoleEnum[] roles?; +}; + +public type ZoneSetDescriptionAction record { + *ZoneUpdateAction; + string action?; + string description?; +}; + +public type ProductSelectionDeletedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + LocalizedString name?; +}; + +public type MyCartSetCountryAction record { + *MyCartUpdateAction; + string action?; + CountryCode country?; +}; + +public type SearchExecutionFailureError record { + *ErrorObject; + string code?; + string message?; +}; + +public type PaymentTransitionStateAction record { + *PaymentUpdateAction; + string action?; + StateResourceIdentifier state?; + boolean force?; +}; + +public type OrderResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type MyCartSetBillingAddressAction record { + *MyCartUpdateAction; + string action?; + BaseAddress address?; +}; + +public type Order record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string completedAt?; + string orderNumber?; + string customerId?; + string customerEmail?; + string anonymousId?; + StoreKeyReference store?; + LineItem[] lineItems?; + CustomLineItem[] customLineItems?; + TypedMoney totalPrice?; + TaxedPrice taxedPrice?; + Address shippingAddress?; + Address billingAddress?; + TaxMode taxMode?; + RoundingMode taxRoundingMode?; + CustomerGroupReference customerGroup?; + string country?; + OrderState orderState?; + StateReference state?; + ShipmentState shipmentState?; + PaymentState paymentState?; + ShippingInfo shippingInfo?; + SyncInfo[] syncInfo?; + ReturnInfo[] returnInfo?; + DiscountCodeInfo[] discountCodes?; + int lastMessageSequenceNumber?; + CartReference cart?; + CustomFields custom?; + PaymentInfo paymentInfo?; + string locale?; + InventoryMode inventoryMode?; + CartOrigin origin?; + TaxCalculationMode taxCalculationMode?; + ShippingRateInput shippingRateInput?; + Address[] itemShippingAddresses?; + CartDiscountReference[] refusedGifts?; +}; + +public type CartChangeCustomLineItemQuantityAction record { + *CartUpdateAction; + string action?; + string customLineItemId?; + int quantity?; +}; + +public type OrderEditAddStagedActionAction record { + *OrderEditUpdateAction; + string action?; + StagedOrderUpdateAction stagedAction?; +}; + +public type Channel record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + ChannelRoleEnum[] roles?; + LocalizedString name?; + LocalizedString description?; + Address address?; + ReviewRatingStatistics reviewRatingStatistics?; + CustomFields custom?; + GeoJson geoLocation?; +}; + +public type CustomerToken record { + string id?; + string createdAt?; + string lastModifiedAt?; + string customerId?; + string expiresAt?; + string value?; +}; + +public type MyCustomerSetDefaultShippingAddressAction record { + *MyCustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type StagedOrderSetShippingAddressCustomFieldAction record { + *StagedOrderUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type StagedOrderAddPaymentAction record { + *StagedOrderUpdateAction; + string action?; + PaymentResourceIdentifier payment?; +}; + +public type ClassificationShippingRateInput record { + *ShippingRateInput; + string 'type?; + string 'key?; + LocalizedString label?; +}; + +public type CartDiscountValueFixedDraft record { + *CartDiscountValueDraft; + string 'type?; + Money[] money?; +}; + +public type DeliveryItemsUpdatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string deliveryId?; + DeliveryItem[] items?; + DeliveryItem[] oldItems?; +}; + +public type ProductSetMetaTitleAction record { + *ProductUpdateAction; + string action?; + LocalizedString metaTitle?; + boolean staged?; +}; + +public type PaymentSetKeyAction record { + *PaymentUpdateAction; + string action?; + string 'key?; +}; + +public type CustomFields record { + TypeReference 'type?; + FieldContainer fields?; +}; + +public type StagedOrderSetItemShippingAddressCustomTypeAction record { + *StagedOrderUpdateAction; + string action?; + string addressKey?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type OrderSetBillingAddressCustomFieldAction record { + *OrderUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type StagedOrderSetShippingMethodAction record { + *StagedOrderUpdateAction; + string action?; + ShippingMethodResourceIdentifier shippingMethod?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type MyPaymentSetMethodInfoInterfaceAction record { + *MyPaymentUpdateAction; + string action?; + string interface?; +}; + +public type ShipmentState string; + +public type ItemShippingDetails record { + ItemShippingTarget[] targets?; + boolean valid?; +}; + +public type CartSetItemShippingAddressCustomTypeAction record { + *CartUpdateAction; + string action?; + string addressKey?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type Message record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; +}; + +public type ExtensionSetKeyAction record { + *ExtensionUpdateAction; + string action?; + string 'key?; +}; + +public type OrderAddDeliveryAction record { + *OrderUpdateAction; + string action?; + DeliveryItem[] items?; + BaseAddress address?; + ParcelDraft[] parcels?; + CustomFields custom?; +}; + +public type InventoryEntryAddQuantityAction record { + *InventoryEntryUpdateAction; + string action?; + int quantity?; +}; + +public type ProjectChangeMessagesConfigurationAction record { + *ProjectUpdateAction; + string action?; + MessageConfigurationDraft messagesConfiguration?; +}; + +public type CartDiscountSetCustomTypeAction record { + *CartDiscountUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + record {} fields?; +}; + +public type ProductImageAddedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + int variantId?; + Image image?; + boolean staged?; +}; + +public type AttributeDefinition record { + AttributeType 'type?; + string name?; + LocalizedString label?; + boolean isRequired?; + AttributeConstraintEnum attributeConstraint?; + LocalizedString inputTip?; + TextInputHint inputHint?; + boolean isSearchable?; +}; + +public type ProductAddedToCategoryMessagePayload record { + *MessagePayload; + string 'type?; + CategoryReference category?; + boolean staged?; +}; + +public type ProductSelection record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + LocalizedString name?; + int productCount?; + ProductSelectionTypeEnum 'type?; +}; + +public type CartDiscountSetValidUntilAction record { + *CartDiscountUpdateAction; + string action?; + string validUntil?; +}; + +public type ExternalTaxAmountDraft record { + Money totalGross?; + ExternalTaxRateDraft taxRate?; +}; + +public type OrderAddReturnInfoAction record { + *OrderUpdateAction; + string action?; + string returnTrackingId?; + ReturnItemDraft[] items?; + string returnDate?; +}; + +public type OrderCustomerSetMessagePayload record { + *MessagePayload; + string 'type?; + CustomerReference customer?; + CustomerGroupReference customerGroup?; + CustomerReference oldCustomer?; + CustomerGroupReference oldCustomerGroup?; +}; + +public type MyCartAddItemShippingAddressAction record { + *MyCartUpdateAction; + string action?; + BaseAddress address?; +}; + +public type OrderDiscountCodeAddedMessagePayload record { + *MessagePayload; + string 'type?; + DiscountCodeReference discountCode?; +}; + +public type ProductSetProductVariantKeyAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + string 'key?; + boolean staged?; +}; + +public type StoreAddDistributionChannelAction record { + *StoreUpdateAction; + string action?; + ChannelResourceIdentifier distributionChannel?; +}; + +public type OrderCustomerEmailSetMessagePayload record { + *MessagePayload; + string 'type?; + string email?; + string oldEmail?; +}; + +public type LineItemStateTransitionMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string lineItemId?; + string transitionDate?; + int quantity?; + StateReference fromState?; + StateReference toState?; +}; + +public type OrderDiscountCodeStateSetMessagePayload record { + *MessagePayload; + string 'type?; + DiscountCodeReference discountCode?; + DiscountCodeState state?; + DiscountCodeState oldState?; +}; + +public type StagedOrderSetReturnPaymentStateAction record { + *StagedOrderUpdateAction; + string action?; + string returnItemId?; + ReturnPaymentState paymentState?; +}; + +public type WhitespaceTokenizer record { + *SuggestTokenizer; + string 'type?; +}; + +public type ExternalOAuth record { + string url?; + string authorizationHeader?; +}; + +public type ProductUnpublishedMessagePayload record { + *MessagePayload; + string 'type?; +}; + +public type ProductImageAddedMessagePayload record { + *MessagePayload; + string 'type?; + int variantId?; + Image image?; + boolean staged?; +}; + +public type BaseResource record { + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; +}; + +public type StagedOrderRemoveDeliveryAction record { + *StagedOrderUpdateAction; + string action?; + string deliveryId?; +}; + +public type ProductTypeUpdate record { + int 'version?; + ProductTypeUpdateAction[] actions?; +}; + +public type TypePagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Type[] results?; +}; + +public type CartDiscountValueRelativeDraft record { + *CartDiscountValueDraft; + string 'type?; + int permyriad?; +}; + +public type LineItem record { + string id?; + string productId?; + string productKey?; + LocalizedString name?; + LocalizedString productSlug?; + ProductTypeReference productType?; + ProductVariant variant?; + Price price?; + TaxedItemPrice taxedPrice?; + TypedMoney totalPrice?; + int quantity?; + string addedAt?; + ItemState[] state?; + TaxRate taxRate?; + ChannelReference supplyChannel?; + ChannelReference distributionChannel?; + DiscountedLineItemPriceForQuantity[] discountedPricePerQuantity?; + LineItemPriceMode priceMode?; + LineItemMode lineItemMode?; + CustomFields custom?; + ItemShippingDetails shippingDetails?; + string lastModifiedAt?; +}; + +public type StagedOrderRemoveParcelFromDeliveryAction record { + *StagedOrderUpdateAction; + string action?; + string parcelId?; +}; + +public type OrderEditResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type ShoppingListChangeLineItemsOrderAction record { + *ShoppingListUpdateAction; + string action?; + string[] lineItemOrder?; +}; + +public type StagedOrderSetShippingRateInputAction record { + *StagedOrderUpdateAction; + string action?; + ShippingRateInputDraft shippingRateInput?; +}; + +public type RangeFacetResult record { + *FacetResult; + FacetTypes 'type?; + FacetResultRange[] ranges?; +}; + +public type TaxCategoryRemoveTaxRateAction record { + *TaxCategoryUpdateAction; + string action?; + string taxRateId?; +}; + +public type ReviewDraft record { + string 'key?; + string uniquenessValue?; + string locale?; + string authorName?; + string title?; + string text?; + string|record {}|string[]|decimal|int|boolean target?; + StateResourceIdentifier state?; + int rating?; + CustomerResourceIdentifier customer?; + CustomFieldsDraft custom?; +}; + +public type ProductRemovedFromCategoryMessagePayload record { + *MessagePayload; + string 'type?; + CategoryReference category?; + boolean staged?; +}; + +public type StagedOrderSetReturnItemCustomTypeAction record { + *StagedOrderUpdateAction; + string action?; + string returnItemId?; + TypeResourceIdentifier 'type?; + record {} fields?; +}; + +public type ChannelUpdate record { + int 'version?; + ChannelUpdateAction[] actions?; +}; + +public type InvalidItemShippingDetailsError record { + *ErrorObject; + string code?; + string message?; + string subject?; + string itemId?; +}; + +public type EnumKeyDoesNotExistError record { + *ErrorObject; + string code?; + string message?; + string conflictingEnumKey?; + string conflictingAttributeName?; +}; + +public type PaymentSetCustomTypeAction record { + *PaymentUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type InvalidOperationError record { + *ErrorObject; + string code?; + string message?; +}; + +public type OrderBillingAddressSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Address address?; + Address oldAddress?; +}; + +public type Customer record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string customerNumber?; + string email?; + string password?; + string firstName?; + string lastName?; + string middleName?; + string title?; + string dateOfBirth?; + string companyName?; + string vatId?; + Address[] addresses?; + string defaultShippingAddressId?; + string[] shippingAddressIds?; + string defaultBillingAddressId?; + string[] billingAddressIds?; + boolean isEmailVerified?; + string externalId?; + CustomerGroupReference customerGroup?; + CustomFields custom?; + string locale?; + string salutation?; + string 'key?; + StoreKeyReference[] stores?; +}; + +public type CartSetCustomerGroupAction record { + *CartUpdateAction; + string action?; + CustomerGroupResourceIdentifier customerGroup?; +}; + +public type Product record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + ProductTypeReference productType?; + ProductCatalogData masterData?; + TaxCategoryReference taxCategory?; + StateReference state?; + ReviewRatingStatistics reviewRatingStatistics?; +}; + +public type ShoppingListAddTextLineItemAction record { + *ShoppingListUpdateAction; + string action?; + LocalizedString name?; + LocalizedString description?; + int quantity?; + string addedAt?; + CustomFieldsDraft custom?; +}; + +public type Store record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + LocalizedString name?; + string[] languages?; + ChannelReference[] distributionChannels?; + ChannelReference[] supplyChannels?; + ProductSelectionSetting[] productSelections?; + CustomFields custom?; +}; + +public type DiscountCodeChangeGroupsAction record { + *DiscountCodeUpdateAction; + string action?; + string[] groups?; +}; + +public type CustomerDeletedMessagePayload record { + *MessagePayload; + string 'type?; +}; + +public type PayloadNotIncluded record { + string reason?; + string payloadType?; +}; + +public type CartSetLocaleAction record { + *CartUpdateAction; + string action?; + string locale?; +}; + +public type ResourceIdentifier record { + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type CartDiscountLineItemsTarget record { + *CartDiscountTarget; + string 'type?; + string predicate?; +}; + +public type ChannelRoleEnum string; + +public type DuplicateFieldWithConflictingResourceError record { + *ErrorObject; + string code?; + string message?; + string 'field?; + string|record {}|string[]|decimal|int|boolean duplicateValue?; + Reference conflictingResource?; +}; + +public type MyCartRemoveItemShippingAddressAction record { + *MyCartUpdateAction; + string action?; + string addressKey?; +}; + +public type ShippingMethodSetCustomTypeAction record { + *ShippingMethodUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type CartSetShippingMethodTaxRateAction record { + *CartUpdateAction; + string action?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type ProductDiscountDraft record { + LocalizedString name?; + string 'key?; + LocalizedString description?; + ProductDiscountValueDraft value?; + string predicate?; + string sortOrder?; + boolean isActive?; + string validFrom?; + string validUntil?; +}; + +public type OrderSetDeliveryCustomTypeAction record { + *OrderUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type OrderShippingInfoSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ShippingInfo shippingInfo?; + ShippingInfo oldShippingInfo?; +}; + +public type ProductSelectionProductPagedQueryResponse record { + int 'limit?; + int offset?; + int count?; + int total?; + AssignedProductReference[] results?; +}; + +public type Expansion string; + +public type TaxedPriceDraft record { + Money totalNet?; + Money totalGross?; + TaxPortionDraft[] taxPortions?; +}; + +public type TaxCategoryResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type AttributeConstraintEnum string; + +public type ConcurrentModificationError record { + *ErrorObject; + string code?; + string message?; + int currentVersion?; +}; + +public type StateRemoveRolesAction record { + *StateUpdateAction; + string action?; + StateRoleEnum[] roles?; +}; + +public type MyCustomerSetVatIdAction record { + *MyCustomerUpdateAction; + string action?; + string vatId?; +}; + +public type ProductVariantChannelAvailability record { + boolean isOnStock?; + int restockableInDays?; + int availableQuantity?; +}; + +public type DiscountCodeSetMaxApplicationsAction record { + *DiscountCodeUpdateAction; + string action?; + int maxApplications?; +}; + +public type MyShoppingListSetTextLineItemCustomTypeAction record { + *MyShoppingListUpdateAction; + string action?; + string textLineItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type TaxCategoryUpdate record { + int 'version?; + TaxCategoryUpdateAction[] actions?; +}; + +public type CartUpdateAction record { + string action?; +}; + +public type StagedOrderSetShippingAddressAndCustomShippingMethodAction record { + *StagedOrderUpdateAction; + string action?; + BaseAddress address?; + string shippingMethodName?; + ShippingRateDraft shippingRate?; + TaxCategoryResourceIdentifier taxCategory?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type ProductAddAssetAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; + AssetDraft asset?; + int position?; +}; + +public type CustomFieldReferenceType record { + *FieldType; + string name?; + ReferenceTypeId referenceTypeId?; +}; + +public type CategoryUpdateAction record { + string action?; +}; + +public type CartDiscountCustomLineItemsTarget record { + *CartDiscountTarget; + string 'type?; + string predicate?; +}; + +public type ZoneResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type OrderSetLineItemShippingDetailsAction record { + *OrderUpdateAction; + string action?; + string lineItemId?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type StagedOrderAddReturnInfoAction record { + *StagedOrderUpdateAction; + string action?; + string returnTrackingId?; + ReturnItemDraft[] items?; + string returnDate?; +}; + +public type StateResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type CartSetBillingAddressAction record { + *CartUpdateAction; + string action?; + BaseAddress address?; +}; + +public type LastModifiedBy record { + *ClientLogging; + string clientId?; + string externalUserId?; + CustomerReference customer?; + string anonymousId?; +}; + +public type ProductPublishedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string[] removedImageUrls?; + ProductProjection productProjection?; + ProductPublishScope scope?; +}; + +public type CartPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Cart[] results?; +}; + +public type CustomerResetPassword record { + string tokenValue?; + string newPassword?; + int 'version?; +}; + +public type InventoryEntry record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string sku?; + ChannelReference supplyChannel?; + int quantityOnStock?; + int availableQuantity?; + int restockableInDays?; + string expectedDelivery?; + CustomFields custom?; +}; + +public type ProjectChangeLanguagesAction record { + *ProjectUpdateAction; + string action?; + Locale[] languages?; +}; + +public type StagedOrderChangeCustomLineItemMoneyAction record { + *StagedOrderUpdateAction; + string action?; + string customLineItemId?; + Money money?; +}; + +public type ProductSelectionPagedQueryResponse record { + int 'limit?; + int offset?; + int count?; + int total?; + ProductSelection[] results?; +}; + +public type DuplicateAttributeValueError record { + *ErrorObject; + string code?; + string message?; + Attribute attribute?; +}; + +public type InventoryMode string; + +public type StagedOrderSetDeliveryAddressCustomTypeAction record { + *StagedOrderUpdateAction; + string action?; + string deliveryId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type MyShoppingListSetCustomFieldAction record { + *MyShoppingListUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ClassificationShippingRateInputDraft record { + *ShippingRateInputDraft; + string 'type?; + string 'key?; +}; + +public type CustomerAddressChangedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Address address?; +}; + +public type OrderReturnInfoSetMessagePayload record { + *MessagePayload; + string 'type?; + ReturnInfo[] returnInfo?; +}; + +public type GraphQLError record { + string message?; + GraphQLErrorLocation[] locations?; + (string|record {}|string[]|decimal|int|boolean)[] path?; +}; + +public type MissingRoleOnChannelError record { + *ErrorObject; + string code?; + string message?; + ChannelResourceIdentifier 'channel?; + ChannelRoleEnum missingRole?; +}; + +public type CartSetLineItemTaxAmountAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + ExternalTaxAmountDraft externalTaxAmount?; +}; + +public type MyCustomerSetLastNameAction record { + *MyCustomerUpdateAction; + string action?; + string lastName?; +}; + +public type CentPrecisionMoney record { + *TypedMoney; + MoneyType 'type?; + int fractionDigits?; + int centAmount?; + CurrencyCode currencyCode?; +}; + +public type DiscountedPrice record { + TypedMoney value?; + ProductDiscountReference discount?; +}; + +public type PaymentAddInterfaceInteractionAction record { + *PaymentUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type TaxCategory record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string name?; + string description?; + TaxRate[] rates?; + string 'key?; +}; + +public type CustomFieldEnumValue record { + string 'key?; + string label?; +}; + +public type ChannelSetAddressCustomTypeAction record { + *ChannelUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type CustomerGroupDraft record { + string 'key?; + string groupName?; + CustomFieldsDraft custom?; +}; + +public type MyCustomerSetTitleAction record { + *MyCustomerUpdateAction; + string action?; + string title?; +}; + +public type OrderEditSetKeyAction record { + *OrderEditUpdateAction; + string action?; + string 'key?; +}; + +public type ProductTypeRemoveEnumValuesAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + string[] keys?; +}; + +public type MyCustomerSetDefaultBillingAddressAction record { + *MyCustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type ProjectChangeMessagesEnabledAction record { + *ProjectUpdateAction; + string action?; + boolean messagesEnabled?; +}; + +public type CategoryChangeParentAction record { + *CategoryUpdateAction; + string action?; + CategoryResourceIdentifier parent?; +}; + +public type ErrorResponse record { + int statusCode?; + string message?; + string _error?; + string error_description?; + ErrorObject[] errors?; +}; + +public type MyShoppingListUpdateAction record { + string action?; +}; + +public type MessageSubscription record { + string resourceTypeId?; + string[] types?; +}; + +public type ParcelTrackingDataUpdatedMessagePayload record { + *MessagePayload; + string 'type?; + string deliveryId?; + string parcelId?; + TrackingData trackingData?; +}; + +public type CartSetCustomShippingMethodAction record { + *CartUpdateAction; + string action?; + string shippingMethodName?; + ShippingRateDraft shippingRate?; + TaxCategoryResourceIdentifier taxCategory?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type DuplicateEnumValuesError record { + *ErrorObject; + string code?; + string message?; + string[] duplicates?; +}; + +public type StagedOrderSetCustomLineItemTaxRateAction record { + *StagedOrderUpdateAction; + string action?; + string customLineItemId?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type StateDraft record { + string 'key?; + StateTypeEnum 'type?; + LocalizedString name?; + LocalizedString description?; + boolean initial?; + StateRoleEnum[] roles?; + StateResourceIdentifier[] transitions?; +}; + +public type ProductUnpublishedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; +}; + +public type PaymentAddTransactionAction record { + *PaymentUpdateAction; + string action?; + TransactionDraft 'transaction?; +}; + +public type CustomerSetExternalIdAction record { + *CustomerUpdateAction; + string action?; + string externalId?; +}; + +public type ShoppingListChangeTextLineItemsOrderAction record { + *ShoppingListUpdateAction; + string action?; + string[] textLineItemOrder?; +}; + +public type CustomerDeletedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; +}; + +public type OrderStateChangedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + OrderState orderState?; + OrderState oldOrderState?; +}; + +public type ProductChangeSlugAction record { + *ProductUpdateAction; + string action?; + LocalizedString slug?; + boolean staged?; +}; + +public type ShippingMethod record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + string name?; + LocalizedString localizedName?; + string description?; + LocalizedString localizedDescription?; + TaxCategoryReference taxCategory?; + ZoneRate[] zoneRates?; + boolean isDefault?; + string predicate?; + CustomFields custom?; +}; + +public type MyShoppingListChangeLineItemQuantityAction record { + *MyShoppingListUpdateAction; + string action?; + string lineItemId?; + int quantity?; +}; + +public type CustomerGroupSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + CustomerGroupReference customerGroup?; +}; + +public type TypeChangeFieldDefinitionOrderAction record { + *TypeUpdateAction; + string action?; + string[] fieldNames?; +}; + +public type LineItemStateTransitionMessagePayload record { + *MessagePayload; + string 'type?; + string lineItemId?; + string transitionDate?; + int quantity?; + StateReference fromState?; + StateReference toState?; +}; + +public type ProductRemoveImageAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + string imageUrl?; + boolean staged?; +}; + +public type CartSetCustomerEmailAction record { + *CartUpdateAction; + string action?; + string email?; +}; + +public type ProductVariantAvailability record { + boolean isOnStock?; + int restockableInDays?; + int availableQuantity?; + ProductVariantChannelAvailabilityMap channels?; +}; + +public type MessageConfigurationDraft record { + boolean enabled?; + int deleteDaysAfterCreation?; +}; + +public type MyCustomerSetLocaleAction record { + *MyCustomerUpdateAction; + string action?; + string locale?; +}; + +public type MyShoppingListChangeNameAction record { + *MyShoppingListUpdateAction; + string action?; + LocalizedString name?; +}; + +public type PaymentInteractionAddedMessagePayload record { + *MessagePayload; + string 'type?; + CustomFields interaction?; +}; + +public type OrderSetItemShippingAddressCustomFieldAction record { + *OrderUpdateAction; + string action?; + string addressKey?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ScoreShippingRateInputDraft record { + *ShippingRateInputDraft; + string 'type?; + float score?; +}; + +public type MyCustomerUpdate record { + int 'version?; + MyCustomerUpdateAction[] actions?; +}; + +public type ProductTypeChangeIsSearchableAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + boolean isSearchable?; +}; + +public type ReturnInfo record { + ReturnItem[] items?; + string returnTrackingId?; + string returnDate?; +}; + +public type TermFacetResult record { + *FacetResult; + FacetTypes 'type?; + TermFacetResultType dataType?; + int missing?; + int total?; + int other?; + FacetResultTerm[] terms?; +}; + +public type ZoneRate record { + ZoneReference zone?; + ShippingRate[] shippingRates?; +}; + +public type ProductVariantAddedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ProductVariant variant?; + boolean staged?; +}; + +public type CustomerEmailChangedMessagePayload record { + *MessagePayload; + string 'type?; + string email?; +}; + +public type OrderAddPaymentAction record { + *OrderUpdateAction; + string action?; + PaymentResourceIdentifier payment?; +}; + +public type UserProvidedIdentifiers record { + string 'key?; + string externalId?; + string orderNumber?; + string customerNumber?; + string sku?; + LocalizedString slug?; + ContainerAndKey containerAndKey?; +}; + +public type ProductSetAttributeAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; + boolean staged?; +}; + +public type ReviewSetLocaleAction record { + *ReviewUpdateAction; + string action?; + string locale?; +}; + +public type ReviewTransitionStateAction record { + *ReviewUpdateAction; + string action?; + StateResourceIdentifier state?; + boolean force?; +}; + +public type ApiClient record { + string id?; + string name?; + string scope?; + string secret?; + string lastUsedAt?; + string deleteAt?; + string createdAt?; +}; + +public type CartAddItemShippingAddressAction record { + *CartUpdateAction; + string action?; + BaseAddress address?; +}; + +public type InventoryEntryDraft record { + string sku?; + ChannelResourceIdentifier supplyChannel?; + int quantityOnStock?; + int restockableInDays?; + string expectedDelivery?; + CustomFieldsDraft custom?; +}; + +public type CategoryCreatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Category category?; +}; + +public type CustomerCreatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Customer customer?; +}; + +public type InventoryEntryQuantitySetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + int oldQuantityOnStock?; + int newQuantityOnStock?; + int oldAvailableQuantity?; + int newAvailableQuantity?; + ChannelReference supplyChannel?; +}; + +public type ReviewSetTitleAction record { + *ReviewUpdateAction; + string action?; + string title?; +}; + +public type TypeAddFieldDefinitionAction record { + *TypeUpdateAction; + string action?; + FieldDefinition fieldDefinition?; +}; + +public type CustomerSetDateOfBirthAction record { + *CustomerUpdateAction; + string action?; + string dateOfBirth?; +}; + +public type SelectionMode string; + +public type ExternalOAuthFailedError record { + *ErrorObject; + string code?; + string message?; +}; + +public type StoreRemoveSupplyChannelAction record { + *StoreUpdateAction; + string action?; + ChannelResourceIdentifier supplyChannel?; +}; + +public type MyPayment record { + string id?; + int 'version?; + CustomerReference customer?; + string anonymousId?; + TypedMoney amountPlanned?; + PaymentMethodInfo paymentMethodInfo?; + Transaction[] transactions?; + CustomFields custom?; +}; + +public type LineItemReturnItem record { + *ReturnItem; + string id?; + int quantity?; + string 'type?; + string comment?; + ReturnShipmentState shipmentState?; + ReturnPaymentState paymentState?; + CustomFields custom?; + string lastModifiedAt?; + string createdAt?; + string lineItemId?; +}; + +public type ShoppingListSetSlugAction record { + *ShoppingListUpdateAction; + string action?; + LocalizedString slug?; +}; + +public type CartDiscountSetKeyAction record { + *CartDiscountUpdateAction; + string action?; + string 'key?; +}; + +public type LineItemDraft record { + string productId?; + int variantId?; + string sku?; + int quantity?; + string addedAt?; + ChannelResourceIdentifier supplyChannel?; + ChannelResourceIdentifier distributionChannel?; + ExternalTaxRateDraft externalTaxRate?; + CustomFieldsDraft custom?; + Money externalPrice?; + ExternalLineItemTotalPrice externalTotalPrice?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type CartSetDeliveryAddressCustomFieldAction record { + *CartUpdateAction; + string action?; + string deliveryId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type MyCartAddDiscountCodeAction record { + *MyCartUpdateAction; + string action?; + string code?; +}; + +public type CategoryOrderHints record { +}; + +public type Money record { + int centAmount?; + CurrencyCode currencyCode?; +}; + +public type MessageConfiguration record { + boolean enabled?; + int deleteDaysAfterCreation?; +}; + +public type MyCartRecalculateAction record { + *MyCartUpdateAction; + string action?; + boolean updateProductData?; +}; + +public type ProductVariantAddedMessagePayload record { + *MessagePayload; + string 'type?; + ProductVariant variant?; + boolean staged?; +}; + +public type ProductSelectionSetKeyAction record { + *ProductSelectionUpdateAction; + string action?; + string 'key?; +}; + +public type CartSetCustomLineItemTaxAmountAction record { + *CartUpdateAction; + string action?; + string customLineItemId?; + ExternalTaxAmountDraft externalTaxAmount?; +}; + +public type ReviewStateTransitionMessagePayload record { + *MessagePayload; + string 'type?; + StateReference oldState?; + StateReference newState?; + boolean oldIncludedInStatistics?; + boolean newIncludedInStatistics?; + Reference target?; + boolean force?; +}; + +public type ProductDiscountValueRelativeDraft record { + *ProductDiscountValueDraft; + string 'type?; + int permyriad?; +}; + +public type CartDiscountValueGiftLineItemDraft record { + *CartDiscountValueDraft; + string 'type?; + ProductResourceIdentifier product?; + int variantId?; + ChannelResourceIdentifier supplyChannel?; + ChannelResourceIdentifier distributionChannel?; +}; + +public type TaxRate record { + string id?; + string name?; + float amount?; + boolean includedInPrice?; + CountryCode country?; + string state?; + SubRate[] subRates?; +}; + +public type StoreAddSupplyChannelAction record { + *StoreUpdateAction; + string action?; + ChannelResourceIdentifier supplyChannel?; +}; + +public type OrderShipmentStateChangedMessagePayload record { + *MessagePayload; + string 'type?; + ShipmentState shipmentState?; + ShipmentState oldShipmentState?; +}; + +public type CustomLineItem record { + string id?; + LocalizedString name?; + TypedMoney money?; + TaxedItemPrice taxedPrice?; + TypedMoney totalPrice?; + string slug?; + int quantity?; + ItemState[] state?; + TaxCategoryReference taxCategory?; + TaxRate taxRate?; + DiscountedLineItemPriceForQuantity[] discountedPricePerQuantity?; + CustomFields custom?; + ItemShippingDetails shippingDetails?; +}; + +public type ZoneDraft record { + string 'key?; + string name?; + string description?; + Location[] locations?; +}; + +public type OrderBillingAddressSetMessagePayload record { + *MessagePayload; + string 'type?; + Address address?; + Address oldAddress?; +}; + +public type CartSetCustomLineItemShippingDetailsAction record { + *CartUpdateAction; + string action?; + string customLineItemId?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type StoreReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + Store obj?; +}; + +public type MyCartChangeTaxModeAction record { + *MyCartUpdateAction; + string action?; + TaxMode taxMode?; +}; + +public type ProductTypeChangeLocalizedEnumValueOrderAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + AttributeLocalizedEnumValue[] values?; +}; + +public type MyPaymentUpdate record { + int 'version?; + MyPaymentUpdateAction[] actions?; +}; + +public type CartSetShippingMethodTaxAmountAction record { + *CartUpdateAction; + string action?; + ExternalTaxAmountDraft externalTaxAmount?; +}; + +public type StagedOrderRemoveDiscountCodeAction record { + *StagedOrderUpdateAction; + string action?; + DiscountCodeReference discountCode?; +}; + +public type DiscountCodeSetValidFromAction record { + *DiscountCodeUpdateAction; + string action?; + string validFrom?; +}; + +public type TypeChangeLocalizedEnumValueOrderAction record { + *TypeUpdateAction; + string action?; + string fieldName?; + string[] keys?; +}; + +public type ShoppingListResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type StagedOrderSetShippingAddressAndShippingMethodAction record { + *StagedOrderUpdateAction; + string action?; + BaseAddress address?; + ShippingMethodResourceIdentifier shippingMethod?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type AttributeMoneyType record { + *AttributeType; + string name?; +}; + +public type AssetDraft record { + AssetSource[] sources?; + LocalizedString name?; + LocalizedString description?; + string[] tags?; + CustomFieldsDraft custom?; + string 'key?; +}; + +public type ProductDiscountValueAbsolute record { + *ProductDiscountValue; + string 'type?; + TypedMoney[] money?; +}; + +public type ShippingMethodDraft record { + string 'key?; + string name?; + LocalizedString localizedName?; + string description?; + LocalizedString localizedDescription?; + TaxCategoryResourceIdentifier taxCategory?; + ZoneRateDraft[] zoneRates?; + boolean isDefault?; + string predicate?; + CustomFieldsDraft custom?; +}; + +public type OrderReturnInfoAddedMessagePayload record { + *MessagePayload; + string 'type?; + ReturnInfo returnInfo?; +}; + +public type SubRate record { + string name?; + float amount?; +}; + +public type Delivery record { + string id?; + string createdAt?; + DeliveryItem[] items?; + Parcel[] parcels?; + Address address?; + CustomFields custom?; +}; + +public type TypeRemoveFieldDefinitionAction record { + *TypeUpdateAction; + string action?; + string fieldName?; +}; + +public type ProductDiscountSetDescriptionAction record { + *ProductDiscountUpdateAction; + string action?; + LocalizedString description?; +}; + +public type CustomerGroupSetMessagePayload record { + *MessagePayload; + string 'type?; + CustomerGroupReference customerGroup?; +}; + +public type Address record { + *BaseAddress; + string id?; + string 'key?; + string title?; + string salutation?; + string firstName?; + string lastName?; + string streetName?; + string streetNumber?; + string additionalStreetInfo?; + string postalCode?; + string city?; + string region?; + string state?; + CountryCode country?; + string company?; + string department?; + string building?; + string apartment?; + string pOBox?; + string phone?; + string mobile?; + string email?; + string fax?; + string additionalAddressInfo?; + string externalId?; + CustomFields custom?; +}; + +public type StateUpdate record { + int 'version?; + StateUpdateAction[] actions?; +}; + +public type StagedOrderSetCountryAction record { + *StagedOrderUpdateAction; + string action?; + string country?; +}; + +public type TypeChangeLocalizedEnumValueLabelAction record { + *TypeUpdateAction; + string action?; + string fieldName?; + CustomFieldLocalizedEnumValue value?; +}; + +public type OrderLineItemDiscountSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string lineItemId?; + DiscountedLineItemPriceForQuantity[] discountedPricePerQuantity?; + Money totalPrice?; + TaxedItemPrice taxedPrice?; +}; + +public type ProductSelectionDeletedMessagePayload record { + *MessagePayload; + string 'type?; + LocalizedString name?; +}; + +public type CategoryChangeAssetNameAction record { + *CategoryUpdateAction; + string action?; + string assetId?; + string assetKey?; + LocalizedString name?; +}; + +public type AttributeSetType record { + *AttributeType; + string name?; + AttributeType elementType?; +}; + +public type Image record { + string url?; + ImageDimensions dimensions?; + string label?; +}; + +public type PaymentSetAuthorizationAction record { + *PaymentUpdateAction; + string action?; + Money amount?; + string until?; +}; + +public type ProductTypeChangeEnumKeyAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + string 'key?; + string newKey?; +}; + +public type ExtensionUpdate record { + int 'version?; + ExtensionUpdateAction[] actions?; +}; + +public type OrderDiscountCodeAddedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + DiscountCodeReference discountCode?; +}; + +public type FacetResults record { +}; + +public type CategorySetCustomFieldAction record { + *CategoryUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type OrderEditAppliedMessagePayload record { + *MessagePayload; + string 'type?; + OrderEditReference edit?; + OrderEditApplied result?; +}; + +public type OrderEditNotProcessed record { + *OrderEditResult; + string 'type?; +}; + +public type ShoppingListSetLineItemCustomFieldAction record { + *ShoppingListUpdateAction; + string action?; + string lineItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type CustomerSetLocaleAction record { + *CustomerUpdateAction; + string action?; + string locale?; +}; + +public type ChannelSetGeoLocationAction record { + *ChannelUpdateAction; + string action?; + GeoJson geoLocation?; +}; + +public type CartDiscountChangeValueAction record { + *CartDiscountUpdateAction; + string action?; + CartDiscountValueDraft value?; +}; + +public type ProductCreatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ProductProjection productProjection?; +}; + +public type MyCartApplyDeltaToLineItemShippingDetailsTargetsAction record { + *MyCartUpdateAction; + string action?; + string lineItemId?; + ItemShippingTarget[] targetsDelta?; +}; + +public type StagedOrderAddLineItemAction record { + *StagedOrderUpdateAction; + string action?; + CustomFieldsDraft custom?; + ChannelResourceIdentifier distributionChannel?; + ExternalTaxRateDraft externalTaxRate?; + string productId?; + int variantId?; + string sku?; + float quantity?; + string addedAt?; + ChannelResourceIdentifier supplyChannel?; + Money externalPrice?; + ExternalLineItemTotalPrice externalTotalPrice?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type ShippingMethodSetDescriptionAction record { + *ShippingMethodUpdateAction; + string action?; + string description?; +}; + +public type PaymentSetMethodInfoMethodAction record { + *PaymentUpdateAction; + string action?; + string method?; +}; + +public type ProductDiscountValue record { + string 'type?; +}; + +public type CustomerUpdateAction record { + string action?; +}; + +public type ErrorObject record { + string code?; + string message?; +}; + +public type StagedOrderSetShippingAddressCustomTypeAction record { + *StagedOrderUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ProductDiscountChangeSortOrderAction record { + *ProductDiscountUpdateAction; + string action?; + string sortOrder?; +}; + +public type StoreDraft record { + string 'key?; + LocalizedString name?; + string[] languages?; + ChannelResourceIdentifier[] distributionChannels?; + ChannelResourceIdentifier[] supplyChannels?; + ProductSelectionSettingDraft[] productSelections?; + CustomFieldsDraft custom?; +}; + +public type CategorySetExternalIdAction record { + *CategoryUpdateAction; + string action?; + string externalId?; +}; + +public type GraphQLResponse record { + string|record {}|string[]|decimal|int|boolean data?; + GraphQLError[] errors?; +}; + +public type OrderSetReturnShipmentStateAction record { + *OrderUpdateAction; + string action?; + string returnItemId?; + ReturnShipmentState shipmentState?; +}; + +public type ExtensionAction string; + +public type SubscriptionDelivery record { + string projectKey?; + string notificationType?; + Reference 'resource?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; +}; + +public type MyPaymentPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + MyPayment[] results?; +}; + +public type TextLineItem record { + string addedAt?; + CustomFields custom?; + LocalizedString description?; + string id?; + LocalizedString name?; + int quantity?; +}; + +public type CategorySetAssetKeyAction record { + *CategoryUpdateAction; + string action?; + string assetId?; + string assetKey?; +}; + +public type StagedOrderSetCustomerEmailAction record { + *StagedOrderUpdateAction; + string action?; + string email?; +}; + +public type ShoppingListSetTextLineItemDescriptionAction record { + *ShoppingListUpdateAction; + string action?; + string textLineItemId?; + LocalizedString description?; +}; + +public type ProductRevertedStagedChangesMessagePayload record { + *MessagePayload; + string 'type?; + string[] removedImageUrls?; +}; + +public type CartRecalculateAction record { + *CartUpdateAction; + string action?; + boolean updateProductData?; +}; + +public type ReferenceExistsError record { + *ErrorObject; + string code?; + string message?; + ReferenceTypeId referencedBy?; +}; + +public type CategoryChangeSlugAction record { + *CategoryUpdateAction; + string action?; + LocalizedString slug?; +}; + +public type GoogleCloudPubSubDestination record { + *Destination; + string 'type?; + string projectId?; + string topic?; +}; + +public type CartDiscountValueFixed record { + *CartDiscountValue; + string 'type?; + TypedMoney[] money?; +}; + +public type ProductDiscountChangeNameAction record { + *ProductDiscountUpdateAction; + string action?; + LocalizedString name?; +}; + +public type StagedOrderSetShippingMethodTaxAmountAction record { + *StagedOrderUpdateAction; + string action?; + ExternalTaxAmountDraft externalTaxAmount?; +}; + +public type PriceFunction record { + CurrencyCode currencyCode?; + string 'function?; +}; + +public type CartDiscountValue record { + string 'type?; +}; + +public type StagedOrderSetCustomerIdAction record { + *StagedOrderUpdateAction; + string action?; + string customerId?; +}; + +public type ProductSelectionRemoveProductAction record { + *ProductSelectionUpdateAction; + string action?; + ProductResourceIdentifier product?; +}; + +public type OrderStoreSetMessagePayload record { + *MessagePayload; + string 'type?; + StoreKeyReference store?; +}; + +public type StoreSetSupplyChannelsAction record { + *StoreUpdateAction; + string action?; + ChannelResourceIdentifier[] supplyChannels?; +}; + +public type CustomerSetCompanyNameAction record { + *CustomerUpdateAction; + string action?; + string companyName?; +}; + +public type PaymentSetAmountRefundedAction record { + *PaymentUpdateAction; + string action?; + Money amount?; +}; + +public type OrderShippingAddressSetMessagePayload record { + *MessagePayload; + string 'type?; + Address address?; + Address oldAddress?; +}; + +public type CartAddDiscountCodeAction record { + *CartUpdateAction; + string action?; + string code?; +}; + +public type ProductAddToCategoryAction record { + *ProductUpdateAction; + string action?; + CategoryResourceIdentifier category?; + string orderHint?; + boolean staged?; +}; + +public type CartDiscountPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + CartDiscount[] results?; +}; + +public type ShoppingListReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + ShoppingList obj?; +}; + +public type InvalidJsonInputError record { + *ErrorObject; + string code?; + string message?; +}; + +public type CartSetLineItemCustomTypeAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ExtensionHttpDestinationAuthentication record { + string 'type?; +}; + +public type MyCartSetCustomTypeAction record { + *MyCartUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ShippingMethodPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + ShippingMethod[] results?; +}; + +public type ChannelSetCustomTypeAction record { + *ChannelUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ShoppingListDraft record { + CustomFieldsDraft custom?; + CustomerResourceIdentifier customer?; + int deleteDaysAfterLastModification?; + LocalizedString description?; + string 'key?; + ShoppingListLineItemDraft[] lineItems?; + LocalizedString name?; + LocalizedString slug?; + TextLineItemDraft[] textLineItems?; + string anonymousId?; + StoreResourceIdentifier store?; +}; + +public type PaymentChangeAmountPlannedAction record { + *PaymentUpdateAction; + string action?; + Money amount?; +}; + +public type PaymentChangeTransactionTimestampAction record { + *PaymentUpdateAction; + string action?; + string transactionId?; + string timestamp?; +}; + +public type Locale string; + +public type StateTypeEnum string; + +public type StagedOrderSetParcelTrackingDataAction record { + *StagedOrderUpdateAction; + string action?; + string parcelId?; + TrackingData trackingData?; +}; + +public type AttributeNumberType record { + *AttributeType; + string name?; +}; + +public type MyShoppingListChangeLineItemsOrderAction record { + *MyShoppingListUpdateAction; + string action?; + string[] lineItemOrder?; +}; + +public type StagedOrderRemovePaymentAction record { + *StagedOrderUpdateAction; + string action?; + PaymentResourceIdentifier payment?; +}; + +public type ProductTypeChangeAttributeOrderAction record { + *ProductTypeUpdateAction; + string action?; + AttributeDefinition[] attributes?; +}; + +public type ProductPublishAction record { + *ProductUpdateAction; + string action?; + ProductPublishScope scope?; +}; + +public type MyTransactionDraft record { + string timestamp?; + TransactionType 'type?; + Money amount?; + string interactionId?; + CustomFields custom?; +}; + +public type ShoppingList record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + CustomFields custom?; + CustomerReference customer?; + int deleteDaysAfterLastModification?; + LocalizedString description?; + string 'key?; + ShoppingListLineItem[] lineItems?; + LocalizedString name?; + LocalizedString slug?; + TextLineItem[] textLineItems?; + string anonymousId?; + StoreKeyReference store?; +}; + +public type OrderSetParcelCustomFieldAction record { + *OrderUpdateAction; + string action?; + string parcelId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ProductTypeChangeInputHintAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + TextInputHint newValue?; +}; + +public type CategoryReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + Category obj?; +}; + +public type StagedOrderAddDiscountCodeAction record { + *StagedOrderUpdateAction; + string action?; + string code?; +}; + +public type ShippingMethodReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + ShippingMethod obj?; +}; + +public type ProductProjectionPagedSearchResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + ProductProjection[] results?; + FacetResults facets?; +}; + +public type ProductChangeAssetOrderAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; + string[] assetOrder?; +}; + +public type OrderLineItemDistributionChannelSetMessagePayload record { + *MessagePayload; + string 'type?; + string lineItemId?; + ChannelReference distributionChannel?; +}; + +public type TextLineItemDraft record { + string addedAt?; + CustomFieldsDraft custom?; + LocalizedString description?; + LocalizedString name?; + int quantity?; +}; + +public type ProductTypeUpdateAction record { + string action?; +}; + +public type ProductSelectionProductRemovedMessagePayload record { + *MessagePayload; + string 'type?; + ProductReference product?; +}; + +public type MessagePagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Message[] results?; +}; + +public type ProductTypeAddPlainEnumValueAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + AttributePlainEnumValue value?; +}; + +public type CartScoreType record { + *ShippingRateInputType; + ShippingRateTierType 'type?; +}; + +public type CategorySetAssetCustomTypeAction record { + *CategoryUpdateAction; + string action?; + string assetId?; + string assetKey?; + TypeResourceIdentifier 'type?; + record {} fields?; +}; + +public type PaymentStatus record { + string interfaceCode?; + string interfaceText?; + StateReference state?; +}; + +public type StagedOrderChangePaymentStateAction record { + *StagedOrderUpdateAction; + string action?; + PaymentState paymentState?; +}; + +public type PaymentChangeTransactionStateAction record { + *PaymentUpdateAction; + string action?; + string transactionId?; + TransactionState state?; +}; + +public type ShippingMethodSetCustomFieldAction record { + *ShippingMethodUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type SnsDestination record { + *Destination; + string 'type?; + string accessKey?; + string accessSecret?; + string topicArn?; +}; + +public type CartSetLineItemDistributionChannelAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + ChannelResourceIdentifier distributionChannel?; +}; + +public type DiscountCodeSetCustomFieldAction record { + *DiscountCodeUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type TypeChangeInputHintAction record { + *TypeUpdateAction; + string action?; + string fieldName?; + TypeTextInputHint inputHint?; +}; + +public type OrderImportCustomLineItemStateAction record { + *OrderUpdateAction; + string action?; + string customLineItemId?; + ItemState[] state?; +}; + +public type CartApplyDeltaToLineItemShippingDetailsTargetsAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + ItemShippingTarget[] targetsDelta?; +}; + +public type Payment record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + CustomerReference customer?; + string anonymousId?; + string externalId?; + string interfaceId?; + TypedMoney amountPlanned?; + TypedMoney amountAuthorized?; + string authorizedUntil?; + TypedMoney amountPaid?; + TypedMoney amountRefunded?; + PaymentMethodInfo paymentMethodInfo?; + PaymentStatus paymentStatus?; + Transaction[] transactions?; + CustomFields[] interfaceInteractions?; + CustomFields custom?; + string 'key?; +}; + +public type StagedOrderRemoveItemShippingAddressAction record { + *StagedOrderUpdateAction; + string action?; + string addressKey?; +}; + +public type ProductProjectionPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + ProductProjection[] results?; +}; + +public type FilteredFacetResult record { + *FacetResult; + FacetTypes 'type?; + int count?; + int productCount?; +}; + +public type Price record { + string id?; + TypedMoney value?; + CountryCode country?; + CustomerGroupReference customerGroup?; + ChannelReference 'channel?; + string validFrom?; + string validUntil?; + DiscountedPrice discounted?; + CustomFields custom?; + PriceTier[] tiers?; +}; + +public type MessageDelivery record { + *SubscriptionDelivery; + string projectKey?; + string notificationType?; + Reference 'resource?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + int sequenceNumber?; + int resourceVersion?; + PayloadNotIncluded payloadNotIncluded?; +}; + +public type ParcelAddedToDeliveryMessagePayload record { + *MessagePayload; + string 'type?; + Delivery delivery?; + Parcel parcel?; +}; + +public type CustomerSetMiddleNameAction record { + *CustomerUpdateAction; + string action?; + string middleName?; +}; + +public type AttributeTimeType record { + *AttributeType; + string name?; +}; + +public type ReviewRatingSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + float oldRating?; + float newRating?; + boolean includedInStatistics?; + Reference target?; +}; + +public type StagedOrderChangeTaxCalculationModeAction record { + *StagedOrderUpdateAction; + string action?; + TaxCalculationMode taxCalculationMode?; +}; + +public type Destination record { + string 'type?; +}; + +public type ShoppingListLineItem record { + string addedAt?; + CustomFields custom?; + string deactivatedAt?; + string id?; + LocalizedString name?; + string productId?; + LocalizedString productSlug?; + ProductTypeReference productType?; + int quantity?; + ProductVariant variant?; + int variantId?; +}; + +public type AnonymousIdAlreadyInUseError record { + *ErrorObject; + string code?; + string message?; +}; + +public type ProductSelectionAddProductAction record { + *ProductSelectionUpdateAction; + string action?; + ProductResourceIdentifier product?; +}; + +public type DuplicateFieldError record { + *ErrorObject; + string code?; + string message?; + string 'field?; + string|record {}|string[]|decimal|int|boolean duplicateValue?; + Reference conflictingResource?; +}; + +public type AttributePlainEnumValue record { + string 'key?; + string label?; +}; + +public type OrderPaymentStateChangedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + PaymentState paymentState?; + PaymentState oldPaymentState?; +}; + +public type ShippingMethodSetPredicateAction record { + *ShippingMethodUpdateAction; + string action?; + string predicate?; +}; + +public type PaymentStatusStateTransitionMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + StateReference state?; + boolean force?; +}; + +public type CartRemoveItemShippingAddressAction record { + *CartUpdateAction; + string action?; + string addressKey?; +}; + +public type OrderSetCustomFieldAction record { + *OrderUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ProductSetCategoryOrderHintAction record { + *ProductUpdateAction; + string action?; + string categoryId?; + string orderHint?; + boolean staged?; +}; + +public type CountryCode string; + +public type AttributeBooleanType record { + *AttributeType; + string name?; +}; + +public type OrderStateChangedMessagePayload record { + *MessagePayload; + string 'type?; + OrderState orderState?; + OrderState oldOrderState?; +}; + +public type PaymentCreatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Payment payment?; +}; + +public type StoreSetCustomFieldAction record { + *StoreUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type CategoryChangeOrderHintAction record { + *CategoryUpdateAction; + string action?; + string orderHint?; +}; + +public type PaymentTransactionStateChangedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string transactionId?; + TransactionState state?; +}; + +public type ExtensionPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Extension[] results?; +}; + +public type InventoryEntryQuantitySetMessagePayload record { + *MessagePayload; + string 'type?; + int oldQuantityOnStock?; + int newQuantityOnStock?; + int oldAvailableQuantity?; + int newAvailableQuantity?; + ChannelReference supplyChannel?; +}; + +public type StagedOrderAddShoppingListAction record { + *StagedOrderUpdateAction; + string action?; + ShoppingListResourceIdentifier shoppingList?; + ChannelResourceIdentifier supplyChannel?; + ChannelResourceIdentifier distributionChannel?; +}; + +public type OrderShipmentStateChangedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ShipmentState shipmentState?; + ShipmentState oldShipmentState?; +}; + +public type StagedOrderSetOrderTotalTaxAction record { + *StagedOrderUpdateAction; + string action?; + Money externalTotalGross?; + TaxPortionDraft[] externalTaxPortions?; +}; + +public type ChannelPagedQueryResponse record { + int 'limit?; + int offset?; + int count?; + int total?; + Channel[] results?; +}; + +public type OrderEditResult record { + string 'type?; +}; + +public type OrderDiscountCodeRemovedMessagePayload record { + *MessagePayload; + string 'type?; + DiscountCodeReference discountCode?; +}; + +public type OrderRemoveParcelFromDeliveryAction record { + *OrderUpdateAction; + string action?; + string parcelId?; +}; + +public type ProductSetSearchKeywordsAction record { + *ProductUpdateAction; + string action?; + SearchKeywords searchKeywords?; + boolean staged?; +}; + +public type FieldType record { + string name?; +}; + +public type ScoreShippingRateInput record { + *ShippingRateInput; + string 'type?; + float score?; +}; + +public type MyShoppingListSetDeleteDaysAfterLastModificationAction record { + *MyShoppingListUpdateAction; + string action?; + int deleteDaysAfterLastModification?; +}; + +public type MyCartSetLineItemCustomFieldAction record { + *MyCartUpdateAction; + string action?; + string lineItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type OrderImportLineItemStateAction record { + *OrderUpdateAction; + string action?; + string lineItemId?; + ItemState[] state?; +}; + +public type ProductDiscountSetValidFromAction record { + *ProductDiscountUpdateAction; + string action?; + string validFrom?; +}; + +public type StateSetNameAction record { + *StateUpdateAction; + string action?; + LocalizedString name?; +}; + +public type StagedOrderSetBillingAddressAction record { + *StagedOrderUpdateAction; + string action?; + BaseAddress address?; +}; + +public type PaymentDraft record { + CustomerResourceIdentifier customer?; + string anonymousId?; + string externalId?; + string interfaceId?; + Money amountPlanned?; + Money amountAuthorized?; + string authorizedUntil?; + Money amountPaid?; + Money amountRefunded?; + PaymentMethodInfo paymentMethodInfo?; + PaymentStatusDraft paymentStatus?; + TransactionDraft[] transactions?; + CustomFieldsDraft[] interfaceInteractions?; + CustomFieldsDraft custom?; + string 'key?; +}; + +public type ReviewRatingStatistics record { + float averageRating?; + float highestRating?; + float lowestRating?; + int count?; + record {} ratingsDistribution?; +}; + +public type MyPaymentSetCustomFieldAction record { + *MyPaymentUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type CartDiscountSetDescriptionAction record { + *CartDiscountUpdateAction; + string action?; + LocalizedString description?; +}; + +public type ProductAddPriceAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + PriceDraft price?; + boolean staged?; +}; + +public type ProductTypeReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + ProductType obj?; +}; + +public type ExtensionSetTimeoutInMsAction record { + *ExtensionUpdateAction; + string action?; + int timeoutInMs?; +}; + +public type ReturnItem record { + string id?; + int quantity?; + string 'type?; + string comment?; + ReturnShipmentState shipmentState?; + ReturnPaymentState paymentState?; + CustomFields custom?; + string lastModifiedAt?; + string createdAt?; +}; + +public type ProductDeletedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string[] removedImageUrls?; + ProductProjection currentProjection?; +}; + +public type StagedOrderSetBillingAddressCustomFieldAction record { + *StagedOrderUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type StagedOrderSetLineItemTotalPriceAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + ExternalLineItemTotalPrice externalTotalPrice?; +}; + +public type ReviewResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type StagedOrderChangeTaxModeAction record { + *StagedOrderUpdateAction; + string action?; + TaxMode taxMode?; +}; + +public type ProductVariantDeletedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ProductVariant variant?; + string[] removedImageUrls?; +}; + +public type StagedOrderSetLineItemTaxRateAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + ExternalTaxRateDraft externalTaxRate?; +}; + +public type OrderSetReturnItemCustomTypeAction record { + *OrderUpdateAction; + string action?; + string returnItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type PaymentSetInterfaceIdAction record { + *PaymentUpdateAction; + string action?; + string interfaceId?; +}; + +public type StagedOrderSetReturnShipmentStateAction record { + *StagedOrderUpdateAction; + string action?; + string returnItemId?; + ReturnShipmentState shipmentState?; +}; + +public type CentPrecisionMoneyDraft record { + *TypedMoneyDraft; + int centAmount?; + CurrencyCode currencyCode?; + MoneyType 'type?; + int fractionDigits?; +}; + +public type DuplicateAttributeValuesError record { + *ErrorObject; + string code?; + string message?; + Attribute[] attributes?; +}; + +public type TaxedItemPriceDraft record { + Money totalNet?; + Money totalGross?; +}; + +public type CustomerGroupSetKeyAction record { + *CustomerGroupUpdateAction; + string action?; + string 'key?; +}; + +public type OrderEditSetStagedActionsAction record { + *OrderEditUpdateAction; + string action?; + StagedOrderUpdateAction[] stagedActions?; +}; + +public type CartSetLineItemCustomFieldAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type MyShoppingListDraft record { + LocalizedString name?; + LocalizedString description?; + ShoppingListLineItemDraft[] lineItems?; + TextLineItemDraft[] textLineItems?; + CustomFieldsDraft custom?; + int deleteDaysAfterLastModification?; + StoreResourceIdentifier store?; +}; + +public type PaymentSetMethodInfoNameAction record { + *PaymentUpdateAction; + string action?; + LocalizedString name?; +}; + +public type MyCartSetShippingAddressAction record { + *MyCartUpdateAction; + string action?; + BaseAddress address?; +}; + +public type OrderChangeOrderStateAction record { + *OrderUpdateAction; + string action?; + OrderState orderState?; +}; + +public type OrderSetParcelItemsAction record { + *OrderUpdateAction; + string action?; + string parcelId?; + DeliveryItem[] items?; +}; + +public type CreatedBy record { + *ClientLogging; + string clientId?; + string externalUserId?; + CustomerReference customer?; + string anonymousId?; +}; + +public type InventoryEntryDeletedMessagePayload record { + *MessagePayload; + string 'type?; + string sku?; + ChannelReference supplyChannel?; +}; + +public type SubscriptionSetMessagesAction record { + *SubscriptionUpdateAction; + string action?; + MessageSubscription[] messages?; +}; + +public type CartDiscountSetCustomFieldAction record { + *CartDiscountUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ReturnPaymentState string; + +public type ProductSetPricesAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + PriceDraft[] prices?; + boolean staged?; +}; + +public type StagedOrderSetDeliveryAddressCustomFieldAction record { + *StagedOrderUpdateAction; + string action?; + string deliveryId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ProductTypePagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + ProductType[] results?; +}; + +public type InventoryEntrySetExpectedDeliveryAction record { + *InventoryEntryUpdateAction; + string action?; + string expectedDelivery?; +}; + +public type ProductRevertStagedChangesAction record { + *ProductUpdateAction; + string action?; +}; + +public type CustomLineItemDraft record { + LocalizedString name?; + int quantity?; + Money money?; + string slug?; + TaxCategoryResourceIdentifier taxCategory?; + ExternalTaxRateDraft externalTaxRate?; + CustomFieldsDraft custom?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type DeliveryFormat record { + string 'type?; +}; + +public type FacetResult record { + FacetTypes 'type?; +}; + +public type ShoppingListSetDescriptionAction record { + *ShoppingListUpdateAction; + string action?; + LocalizedString description?; +}; + +public type CustomFieldLocalizedEnumValue record { + string 'key?; + LocalizedString label?; +}; + +public type StagedOrderSetShippingAddressAction record { + *StagedOrderUpdateAction; + string action?; + BaseAddress address?; +}; + +public type CategorySetMetaTitleAction record { + *CategoryUpdateAction; + string action?; + LocalizedString metaTitle?; +}; + +public type ExtensionAuthorizationHeaderAuthentication record { + *ExtensionHttpDestinationAuthentication; + string 'type?; + string headerValue?; +}; + +public type ShoppingListChangeTextLineItemQuantityAction record { + *ShoppingListUpdateAction; + string action?; + string textLineItemId?; + int quantity?; +}; + +public type EnumValueIsUsedError record { + *ErrorObject; + string code?; + string message?; +}; + +public type PaymentReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + Payment obj?; +}; + +public type CartSetKeyAction record { + *CartUpdateAction; + string action?; + string 'key?; +}; + +public type CartState string; + +public type OrderImportDraft record { + string orderNumber?; + string customerId?; + string customerEmail?; + LineItemImportDraft[] lineItems?; + CustomLineItemImportDraft[] customLineItems?; + Money totalPrice?; + TaxedPriceDraft taxedPrice?; + BaseAddress shippingAddress?; + BaseAddress billingAddress?; + CustomerGroupResourceIdentifier customerGroup?; + string country?; + OrderState orderState?; + ShipmentState shipmentState?; + PaymentState paymentState?; + ShippingInfoImportDraft shippingInfo?; + string completedAt?; + CustomFieldsDraft custom?; + InventoryMode inventoryMode?; + RoundingMode taxRoundingMode?; + BaseAddress[] itemShippingAddresses?; + StoreResourceIdentifier store?; + CartOrigin origin?; +}; + +public type OrderUpdate record { + int 'version?; + OrderUpdateAction[] actions?; +}; + +public type CategoryAddAssetAction record { + *CategoryUpdateAction; + string action?; + AssetDraft asset?; + int position?; +}; + +public type ProductDiscountChangeIsActiveAction record { + *ProductDiscountUpdateAction; + string action?; + boolean isActive?; +}; + +public type CustomerRemoveShippingAddressIdAction record { + *CustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type ProductRevertStagedVariantChangesAction record { + *ProductUpdateAction; + string action?; + int variantId?; +}; + +public type TypeTextInputHint string; + +public type CartDiscountResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type StoreDeletedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; +}; + +public type ProductPublishedMessagePayload record { + *MessagePayload; + string 'type?; + string[] removedImageUrls?; + ProductProjection productProjection?; + ProductPublishScope scope?; +}; + +public type UpdateAction record { + string action?; +}; + +public type OrderExcerpt record { + TypedMoney totalPrice?; + TaxedPrice taxedPrice?; + int 'version?; +}; + +public type ProductSetProductPriceCustomTypeAction record { + *ProductUpdateAction; + string action?; + string priceId?; + boolean staged?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type OrderReturnInfoSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ReturnInfo[] returnInfo?; +}; + +public type SearchKeywords record { +}; + +public type ProductSlugChangedMessagePayload record { + *MessagePayload; + string 'type?; + LocalizedString slug?; + LocalizedString oldSlug?; +}; + +public type EnumKeyAlreadyExistsError record { + *ErrorObject; + string code?; + string message?; + string conflictingEnumKey?; + string conflictingAttributeName?; +}; + +public type OrderStoreSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + StoreKeyReference store?; +}; + +public type ExtensionAWSLambdaDestination record { + *ExtensionDestination; + string 'type?; + string arn?; + string accessKey?; + string accessSecret?; +}; + +public type CartDiscountTarget record { + string 'type?; +}; + +public type CartRemoveLineItemAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + int quantity?; + Money externalPrice?; + ExternalLineItemTotalPrice externalTotalPrice?; + ItemShippingDetailsDraft shippingDetailsToRemove?; +}; + +public type CartSetCustomLineItemCustomFieldAction record { + *CartUpdateAction; + string action?; + string customLineItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type MyShoppingListRemoveLineItemAction record { + *MyShoppingListUpdateAction; + string action?; + string lineItemId?; + int quantity?; +}; + +public type EventBridgeDestination record { + *Destination; + string 'type?; + string region?; + string accountId?; +}; + +public type MyShoppingListSetTextLineItemDescriptionAction record { + *MyShoppingListUpdateAction; + string action?; + string textLineItemId?; + LocalizedString description?; +}; + +public type StagedOrderSetLineItemCustomFieldAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type OrderEditApplied record { + *OrderEditResult; + string 'type?; + string appliedAt?; + OrderExcerpt excerptBeforeEdit?; + OrderExcerpt excerptAfterEdit?; +}; + +public type CategorySetKeyAction record { + *CategoryUpdateAction; + string action?; + string 'key?; +}; + +public type PaymentPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Payment[] results?; +}; + +public type CartDiscountChangeNameAction record { + *CartDiscountUpdateAction; + string action?; + LocalizedString name?; +}; + +public type StateSetDescriptionAction record { + *StateUpdateAction; + string action?; + LocalizedString description?; +}; + +public type ExtensionBadResponseError record { + *ErrorObject; + string code?; + string message?; + LocalizedString localizedMessage?; + record {} extensionExtraInfo?; + ErrorByExtension errorByExtension?; +}; + +public type OrderSetStoreAction record { + *OrderUpdateAction; + string action?; + StoreResourceIdentifier store?; +}; + +public type AttributeDefinitionDraft record { + AttributeType 'type?; + string name?; + LocalizedString label?; + boolean isRequired?; + AttributeConstraintEnum attributeConstraint?; + LocalizedString inputTip?; + TextInputHint inputHint?; + boolean isSearchable?; +}; + +public type TaxPortionDraft record { + string name?; + float rate?; + Money amount?; +}; + +public type StagedOrderSetParcelCustomFieldAction record { + *StagedOrderUpdateAction; + string action?; + string parcelId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type SearchKeyword record { + string text?; + SuggestTokenizer suggestTokenizer?; +}; + +public type ExtensionAzureFunctionsAuthentication record { + *ExtensionHttpDestinationAuthentication; + string 'type?; + string 'key?; +}; + +public type StoreSetCustomTypeAction record { + *StoreUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + record {} fields?; +}; + +public type DiscountCodeSetNameAction record { + *DiscountCodeUpdateAction; + string action?; + LocalizedString name?; +}; + +public type ProductUpdateAction record { + string action?; +}; + +public type FacetTypes string; + +public type AttributeType record { + string name?; +}; + +public type HighPrecisionMoneyDraft record { + *TypedMoneyDraft; + int centAmount?; + CurrencyCode currencyCode?; + MoneyType 'type?; + int fractionDigits?; + int preciseAmount?; +}; + +public type DeliveryAddressSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string deliveryId?; + Address address?; + Address oldAddress?; +}; + +public type OrderCreatedMessagePayload record { + *MessagePayload; + string 'type?; + Order 'order?; +}; + +public type OrderDeletedMessagePayload record { + *MessagePayload; + string 'type?; + Order 'order?; +}; + +public type ProductSetSkuAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; +}; + +public type DiscountCodeResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type ProductTypeChangeAttributeOrderByNameAction record { + *ProductTypeUpdateAction; + string action?; + string[] attributeNames?; +}; + +public type SqsDestination record { + *Destination; + string 'type?; + string accessKey?; + string accessSecret?; + string queueUrl?; + string region?; +}; + +public type ProductSelectionCreatedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + ProductSelectionType productSelection?; +}; + +public type CustomFieldBooleanType record { + *FieldType; + string name?; +}; + +public type ProductRevertedStagedChangesMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string[] removedImageUrls?; +}; + +public type ShoppingListSetDeleteDaysAfterLastModificationAction record { + *ShoppingListUpdateAction; + string action?; + int deleteDaysAfterLastModification?; +}; + +public type RequiredFieldError record { + *ErrorObject; + string code?; + string message?; + string 'field?; +}; + +public type ShippingMethodUpdate record { + int 'version?; + ShippingMethodUpdateAction[] actions?; +}; + +public type StackingMode string; + +public type StagedOrderSetReturnItemCustomFieldAction record { + *StagedOrderUpdateAction; + string action?; + string returnItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ScopedPrice record { + string id?; + TypedMoney value?; + TypedMoney currentValue?; + CountryCode country?; + CustomerGroupReference customerGroup?; + ChannelReference 'channel?; + string validFrom?; + string validUntil?; + DiscountedPrice discounted?; + CustomFields custom?; +}; + +public type ProductVariantChannelAvailabilityMap record { +}; + +public type CartSetLineItemPriceAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + Money externalPrice?; +}; + +public type ProductVariantDeletedMessagePayload record { + *MessagePayload; + string 'type?; + ProductVariant variant?; + string[] removedImageUrls?; +}; + +public type ShoppingListRemoveLineItemAction record { + *ShoppingListUpdateAction; + string action?; + string lineItemId?; + int quantity?; +}; + +public type CartDiscountValueAbsoluteDraft record { + *CartDiscountValueDraft; + string 'type?; + Money[] money?; +}; + +public type CustomerDateOfBirthSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string dateOfBirth?; +}; + +public type CustomObjectPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + CustomObject[] results?; +}; + +public type MyCustomerAddShippingAddressIdAction record { + *MyCustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type OrderFromCartDraft record { + string id?; + CartResourceIdentifier cart?; + int 'version?; + string orderNumber?; + PaymentState paymentState?; + ShipmentState shipmentState?; + OrderState orderState?; + StateResourceIdentifier state?; +}; + +public type ProductSetDiscountedPriceAction record { + *ProductUpdateAction; + string action?; + string priceId?; + boolean staged?; + DiscountedPriceDraft discounted?; +}; + +public type ProductVariantImportDraft record { + int id?; + string sku?; + PriceDraft[] prices?; + Attribute[] attributes?; + Image[] images?; +}; + +public type ShippingMethodSetKeyAction record { + *ShippingMethodUpdateAction; + string action?; + string 'key?; +}; + +public type SearchIndexingInProgressError record { + *ErrorObject; + string code?; + string message?; +}; + +public type CustomerCreatePasswordResetToken record { + string email?; + int ttlMinutes?; +}; + +public type OrderRemoveItemShippingAddressAction record { + *OrderUpdateAction; + string action?; + string addressKey?; +}; + +public type ObjectNotFoundError record { + *ErrorObject; + string code?; + string message?; +}; + +public type ChangeSubscription record { + string resourceTypeId?; +}; + +public type ProjectChangeCountriesAction record { + *ProjectUpdateAction; + string action?; + CountryCode[] countries?; +}; + +public type MyPaymentSetMethodInfoNameAction record { + *MyPaymentUpdateAction; + string action?; + LocalizedString name?; +}; + +public type ShoppingListSetTextLineItemCustomFieldAction record { + *ShoppingListUpdateAction; + string action?; + string textLineItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type AttributeNestedType record { + *AttributeType; + string name?; + ProductTypeReference typeReference?; +}; + +public type StateChangeInitialAction record { + *StateUpdateAction; + string action?; + boolean initial?; +}; + +public type CustomerFirstNameSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string firstName?; +}; + +public type StagedOrderSetBillingAddressCustomTypeAction record { + *StagedOrderUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type CustomerSetCustomTypeAction record { + *CustomerUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ZoneUpdateAction record { + string action?; +}; + +public type OrderLineItemRemovedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string lineItemId?; + int removedQuantity?; + int newQuantity?; + ItemState[] newState?; + TypedMoney newTotalPrice?; + TaxedItemPrice newTaxedPrice?; + Price newPrice?; + ItemShippingDetails newShippingDetail?; +}; + +public type TypeResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type DiscountCodeDraft record { + LocalizedString name?; + LocalizedString description?; + string code?; + CartDiscountResourceIdentifier[] cartDiscounts?; + string cartPredicate?; + boolean isActive?; + int maxApplications?; + int maxApplicationsPerCustomer?; + CustomFieldsDraft custom?; + string[] groups?; + string validFrom?; + string validUntil?; +}; + +public type StagedOrderSetCustomTypeAction record { + *StagedOrderUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type StagedOrderSetCustomLineItemShippingDetailsAction record { + *StagedOrderUpdateAction; + string action?; + string customLineItemId?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type ExtensionDraft record { + string 'key?; + ExtensionDestination destination?; + ExtensionTrigger[] triggers?; + int timeoutInMs?; +}; + +public type AssetDimensions record { + int w?; + int h?; +}; + +public type ProductSetAssetSourcesAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; + string assetId?; + string assetKey?; + AssetSource[] sources?; +}; + +public type ReviewSetAuthorNameAction record { + *ReviewUpdateAction; + string action?; + string authorName?; +}; + +public type DeliveryRemovedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Delivery delivery?; +}; + +public type OrderSearchStatus string; + +public type ChannelReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + Channel obj?; +}; + +public type DeliveryItemsUpdatedMessagePayload record { + *MessagePayload; + string 'type?; + string deliveryId?; + DeliveryItem[] items?; + DeliveryItem[] oldItems?; +}; + +public type ProductVariant record { + int id?; + string sku?; + string 'key?; + Price[] prices?; + Attribute[] attributes?; + Price price?; + Image[] images?; + Asset[] assets?; + ProductVariantAvailability availability?; + boolean isMatchingVariant?; + ScopedPrice scopedPrice?; + boolean scopedPriceDiscounted?; +}; + +public type ProductSetTaxCategoryAction record { + *ProductUpdateAction; + string action?; + TaxCategoryResourceIdentifier taxCategory?; +}; + +public type ItemShippingTarget record { + string addressKey?; + float quantity?; +}; + +public type AssetSource record { + string uri?; + string 'key?; + AssetDimensions dimensions?; + string contentType?; +}; + +public type MyCartAddPaymentAction record { + *MyCartUpdateAction; + string action?; + PaymentResourceIdentifier payment?; +}; + +public type LineItemImportDraft record { + string productId?; + LocalizedString name?; + ProductVariantImportDraft variant?; + PriceDraft price?; + int quantity?; + ItemState[] state?; + ChannelResourceIdentifier supplyChannel?; + ChannelResourceIdentifier distributionChannel?; + TaxRate taxRate?; + CustomFieldsDraft custom?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type OrderEditSetCustomFieldAction record { + *OrderEditUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type StagedOrderSetDeliveryAddressAction record { + *StagedOrderUpdateAction; + string action?; + string deliveryId?; + BaseAddress address?; +}; + +public type MyCustomerSetCompanyNameAction record { + *MyCustomerUpdateAction; + string action?; + string companyName?; +}; + +public type ProductRemoveVariantAction record { + *ProductUpdateAction; + string action?; + int id?; + string sku?; + boolean staged?; +}; + +public type ProductReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + Product obj?; +}; + +public type ItemShippingDetailsDraft record { + ItemShippingTarget[] targets?; +}; + +public type CartRemoveDiscountCodeAction record { + *CartUpdateAction; + string action?; + DiscountCodeReference discountCode?; +}; + +public type ProductTypeChangeLabelAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + LocalizedString label?; +}; + +public type OrderPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Order[] results?; +}; + +public type ProductSetAssetCustomFieldAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + boolean staged?; + string assetId?; + string assetKey?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type OrderSetCustomLineItemCustomTypeAction record { + *OrderUpdateAction; + string action?; + string customLineItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ProductDeletedMessagePayload record { + *MessagePayload; + string 'type?; + string[] removedImageUrls?; + ProductProjection currentProjection?; +}; + +public type Extension record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + ExtensionDestination destination?; + ExtensionTrigger[] triggers?; + int timeoutInMs?; +}; + +public type OrderEditDraft record { + string 'key?; + OrderReference 'resource?; + StagedOrderUpdateAction[] stagedActions?; + CustomFieldsDraft custom?; + string comment?; + boolean dryRun?; +}; + +public type ProductAddExternalImageAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + Image image?; + boolean staged?; +}; + +public type CustomerSignInResult record { + Customer customer?; + Cart cart?; +}; + +public type ShoppingListSetCustomTypeAction record { + *ShoppingListUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type TaxCategoryReplaceTaxRateAction record { + *TaxCategoryUpdateAction; + string action?; + string taxRateId?; + TaxRateDraft taxRate?; +}; + +public type CustomerSetCustomFieldAction record { + *CustomerUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ProductSetAttributeInAllVariantsAction record { + *ProductUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; + boolean staged?; +}; + +public type CustomerAddShippingAddressIdAction record { + *CustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type OrderStateTransitionMessagePayload record { + *MessagePayload; + string 'type?; + StateReference state?; + StateReference oldState?; + boolean force?; +}; + +public type ChannelResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type CategoryChangeNameAction record { + *CategoryUpdateAction; + string action?; + LocalizedString name?; +}; + +public type MyPaymentAddTransactionAction record { + *MyPaymentUpdateAction; + string action?; + TransactionDraft 'transaction?; +}; + +public type StagedOrderSetCustomLineItemCustomTypeAction record { + *StagedOrderUpdateAction; + string action?; + string customLineItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type DiscountCodeInfo record { + DiscountCodeReference discountCode?; + DiscountCodeState state?; +}; + +public type GeneralError record { + *ErrorObject; + string code?; + string message?; +}; + +public type MyCustomerSetFirstNameAction record { + *MyCustomerUpdateAction; + string action?; + string firstName?; +}; + +public type OrderEditPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + OrderEdit[] results?; +}; + +public type Location record { + CountryCode country?; + string state?; +}; + +public type StoreKeyReference record { + *KeyReference; + ReferenceTypeId typeId?; + string 'key?; +}; + +public type OrderImportedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Order 'order?; +}; + +public type OrderDiscountCodeStateSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + DiscountCodeReference discountCode?; + DiscountCodeState state?; + DiscountCodeState oldState?; +}; + +public type IndividualProductSelectionType record { + *ProductSelectionType; + ProductSelectionTypeEnum 'type?; + LocalizedString name?; +}; + +public type ProductCatalogData record { + boolean published?; + ProductData current?; + ProductData staged?; + boolean hasStagedChanges?; +}; + +public type DeliveryPlatformFormat record { + *DeliveryFormat; + string 'type?; +}; + +public type CustomerCreateEmailToken record { + string id?; + int 'version?; + int ttlMinutes?; +}; + +public type CustomerSignin record { + string email?; + string password?; + string anonymousCartId?; + CartResourceIdentifier anonymousCart?; + AnonymousCartSignInMode anonymousCartSignInMode?; + string anonymousId?; + boolean updateProductData?; +}; + +public type CartClassificationTier record { + *ShippingRatePriceTier; + ShippingRateTierType 'type?; + string value?; + Money price?; + boolean isMatching?; +}; + +public type ExtensionHttpDestination record { + *ExtensionDestination; + string 'type?; + string url?; + ExtensionHttpDestinationAuthentication authentication?; +}; + +public type OrderAddParcelToDeliveryAction record { + *OrderUpdateAction; + string action?; + string deliveryId?; + ParcelMeasurements measurements?; + TrackingData trackingData?; + DeliveryItem[] items?; +}; + +public type PaymentSetExternalIdAction record { + *PaymentUpdateAction; + string action?; + string externalId?; +}; + +public type CartDiscountValueDraft record { + string 'type?; +}; + +public type ResourceDeletedDelivery record { + *SubscriptionDelivery; + string projectKey?; + string notificationType?; + Reference 'resource?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + int 'version?; + string modifiedAt?; + boolean dataErasure?; +}; + +public type MyCartSetCustomerEmailAction record { + *MyCartUpdateAction; + string action?; + string email?; +}; + +public type TransactionDraft record { + string timestamp?; + TransactionType 'type?; + Money amount?; + string interactionId?; + TransactionState state?; + CustomFieldsDraft custom?; +}; + +public type TextInputHint string; + +public type CategorySetAssetSourcesAction record { + *CategoryUpdateAction; + string action?; + string assetId?; + string assetKey?; + AssetSource[] sources?; +}; + +public type ProductTypeAddAttributeDefinitionAction record { + *ProductTypeUpdateAction; + string action?; + AttributeDefinitionDraft attribute?; +}; + +public type CartDiscountChangeCartPredicateAction record { + *CartDiscountUpdateAction; + string action?; + string cartPredicate?; +}; + +public type CustomObject record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string container?; + string 'key?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type PaymentUpdateAction record { + string action?; +}; + +public type ShippingMethodRemoveZoneAction record { + *ShippingMethodUpdateAction; + string action?; + ZoneResourceIdentifier zone?; +}; + +public type StagedOrderSetDeliveryItemsAction record { + *StagedOrderUpdateAction; + string action?; + string deliveryId?; + DeliveryItem[] items?; +}; + +public type OrderSetParcelMeasurementsAction record { + *OrderUpdateAction; + string action?; + string parcelId?; + ParcelMeasurements measurements?; +}; + +public type MyShoppingListSetTextLineItemCustomFieldAction record { + *MyShoppingListUpdateAction; + string action?; + string textLineItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ProductResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type ProductSelectionCreatedMessagePayload record { + *MessagePayload; + string 'type?; + ProductSelectionType productSelection?; +}; + +public type InventoryEntryDeletedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string sku?; + ChannelReference supplyChannel?; +}; + +public type StagedOrderChangeCustomLineItemQuantityAction record { + *StagedOrderUpdateAction; + string action?; + string customLineItemId?; + float quantity?; +}; + +public type DeliveryItem record { + string id?; + int quantity?; +}; + +public type MyCartSetLineItemCustomTypeAction record { + *MyCartUpdateAction; + string action?; + string lineItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type MyShoppingListChangeTextLineItemQuantityAction record { + *MyShoppingListUpdateAction; + string action?; + string textLineItemId?; + int quantity?; +}; + +public type ReviewUpdate record { + int 'version?; + ReviewUpdateAction[] actions?; +}; + +public type CustomerGroupResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type TaxCategoryDraft record { + string name?; + string description?; + TaxRateDraft[] rates?; + string 'key?; +}; + +public type OrderDeletedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Order 'order?; +}; + +public type ProductMoveImageToPositionAction record { + *ProductUpdateAction; + string action?; + int variantId?; + string sku?; + string imageUrl?; + int position?; + boolean staged?; +}; + +public type OrderShippingRateInputSetMessagePayload record { + *MessagePayload; + string 'type?; + ShippingRateInput shippingRateInput?; + ShippingRateInput oldShippingRateInput?; +}; + +public type StoreChangeProductSelectionAction record { + *StoreUpdateAction; + string action?; + ResourceIdentifier productSelection?; + boolean active?; +}; + +public type ChannelSetAddressCustomFieldAction record { + *ChannelUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type MyCartAddLineItemAction record { + *MyCartUpdateAction; + string action?; + CustomFieldsDraft custom?; + ChannelResourceIdentifier distributionChannel?; + ExternalTaxRateDraft externalTaxRate?; + string productId?; + int variantId?; + string sku?; + int quantity?; + ChannelResourceIdentifier supplyChannel?; + Money externalPrice?; + ExternalLineItemTotalPrice externalTotalPrice?; + ItemShippingDetailsDraft shippingDetails?; + string addedAt?; +}; + +public type PaymentChangeTransactionInteractionIdAction record { + *PaymentUpdateAction; + string action?; + string transactionId?; + string interactionId?; +}; + +public type PaymentTransactionAddedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + Transaction 'transaction?; +}; + +public type ShoppingListSetTextLineItemCustomTypeAction record { + *ShoppingListUpdateAction; + string action?; + string textLineItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type StoreResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type ExtensionDestination record { + string 'type?; +}; + +public type StagedOrderSetOrderNumberAction record { + *StagedOrderUpdateAction; + string action?; + string orderNumber?; +}; + +public type OrderSetLineItemCustomFieldAction record { + *OrderUpdateAction; + string action?; + string lineItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type ProjectUpdate record { + int 'version?; + ProjectUpdateAction[] actions?; +}; + +public type InventoryEntryReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + InventoryEntry obj?; +}; + +public type StagedOrderImportLineItemStateAction record { + *StagedOrderUpdateAction; + string action?; + string lineItemId?; + ItemState[] state?; +}; + +public type StagedOrder record { + *Order; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string completedAt?; + string orderNumber?; + string customerId?; + string customerEmail?; + string anonymousId?; + StoreKeyReference store?; + LineItem[] lineItems?; + CustomLineItem[] customLineItems?; + TypedMoney totalPrice?; + TaxedPrice taxedPrice?; + Address shippingAddress?; + Address billingAddress?; + TaxMode taxMode?; + RoundingMode taxRoundingMode?; + CustomerGroupReference customerGroup?; + string country?; + OrderState orderState?; + StateReference state?; + ShipmentState shipmentState?; + PaymentState paymentState?; + ShippingInfo shippingInfo?; + SyncInfo[] syncInfo?; + ReturnInfo[] returnInfo?; + DiscountCodeInfo[] discountCodes?; + int lastMessageSequenceNumber?; + CartReference cart?; + CustomFields custom?; + PaymentInfo paymentInfo?; + string locale?; + InventoryMode inventoryMode?; + CartOrigin origin?; + TaxCalculationMode taxCalculationMode?; + ShippingRateInput shippingRateInput?; + Address[] itemShippingAddresses?; + CartDiscountReference[] refusedGifts?; +}; + +public type PaymentSetStatusInterfaceTextAction record { + *PaymentUpdateAction; + string action?; + string interfaceText?; +}; + +public type CustomerCompanyNameSetMessagePayload record { + *MessagePayload; + string 'type?; + string companyName?; +}; + +public type AzureServiceBusDestination record { + *Destination; + string 'type?; + string connectionString?; +}; + +public type OrderEditApply record { + int editVersion?; + int resourceVersion?; +}; + +public type ChannelChangeNameAction record { + *ChannelUpdateAction; + string action?; + LocalizedString name?; +}; + +public type CartDiscountValueGiftLineItem record { + *CartDiscountValue; + string 'type?; + ProductReference product?; + int variantId?; + ChannelReference supplyChannel?; + ChannelReference distributionChannel?; +}; + +public type InventoryPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + InventoryEntry[] results?; +}; + +public type ReturnShipmentState string; + +public type CartSetLineItemTotalPriceAction record { + *CartUpdateAction; + string action?; + string lineItemId?; + ExternalLineItemTotalPrice externalTotalPrice?; +}; + +public type Cart record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + string 'key?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string customerId?; + string customerEmail?; + string anonymousId?; + StoreKeyReference store?; + LineItem[] lineItems?; + CustomLineItem[] customLineItems?; + TypedMoney totalPrice?; + TaxedPrice taxedPrice?; + CartState cartState?; + Address shippingAddress?; + Address billingAddress?; + InventoryMode inventoryMode?; + TaxMode taxMode?; + RoundingMode taxRoundingMode?; + TaxCalculationMode taxCalculationMode?; + CustomerGroupReference customerGroup?; + CountryCode country?; + ShippingInfo shippingInfo?; + DiscountCodeInfo[] discountCodes?; + CustomFields custom?; + PaymentInfo paymentInfo?; + string locale?; + int deleteDaysAfterLastModification?; + CartDiscountReference[] refusedGifts?; + CartOrigin origin?; + ShippingRateInput shippingRateInput?; + Address[] itemShippingAddresses?; +}; + +public type MyShoppingListRemoveTextLineItemAction record { + *MyShoppingListUpdateAction; + string action?; + string textLineItemId?; + int quantity?; +}; + +public type InventoryEntryUpdateAction record { + string action?; +}; + +public type MyCartRemoveLineItemAction record { + *MyCartUpdateAction; + string action?; + string lineItemId?; + int quantity?; + Money externalPrice?; + ExternalLineItemTotalPrice externalTotalPrice?; + ItemShippingDetailsDraft shippingDetailsToRemove?; +}; + +public type InventoryEntrySetSupplyChannelAction record { + *InventoryEntryUpdateAction; + string action?; + ChannelResourceIdentifier supplyChannel?; +}; + +public type Reference record { + ReferenceTypeId typeId?; + string id?; +}; + +public type EnumValuesMustMatchError record { + *ErrorObject; + string code?; + string message?; +}; + +public type MyLineItemDraft record { + string productId?; + int variantId?; + int quantity?; + string addedAt?; + ChannelResourceIdentifier supplyChannel?; + ChannelResourceIdentifier distributionChannel?; + CustomFieldsDraft custom?; + ItemShippingDetailsDraft shippingDetails?; + string sku?; +}; + +public type OrderSetBillingAddressAction record { + *OrderUpdateAction; + string action?; + BaseAddress address?; +}; + +public type PaymentSetCustomerAction record { + *PaymentUpdateAction; + string action?; + CustomerResourceIdentifier customer?; +}; + +public type PaymentTransactionAddedMessagePayload record { + *MessagePayload; + string 'type?; + Transaction 'transaction?; +}; + +public type ShoppingListSetKeyAction record { + *ShoppingListUpdateAction; + string action?; + string 'key?; +}; + +public type ProductDiscountUpdateAction record { + string action?; +}; + +public type ResourceSizeLimitExceededError record { + *ErrorObject; + string code?; + string message?; +}; + +public type PaymentInteractionAddedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + CustomFields interaction?; +}; + +public type ProductDiscountResourceIdentifier record { + *ResourceIdentifier; + ReferenceTypeId typeId?; + string id?; + string 'key?; +}; + +public type OrderSetCustomLineItemCustomFieldAction record { + *OrderUpdateAction; + string action?; + string customLineItemId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type PaymentSetCustomFieldAction record { + *PaymentUpdateAction; + string action?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type CustomerSetAddressCustomFieldAction record { + *CustomerUpdateAction; + string action?; + string addressId?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type MyCartSetLineItemSupplyChannelAction record { + *MyCartUpdateAction; + string action?; + string lineItemId?; + ChannelResourceIdentifier supplyChannel?; +}; + +public type CartSetBillingAddressCustomTypeAction record { + *CartUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ZoneReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + Zone obj?; +}; + +public type CartOrigin string; + +public type ProductStateTransitionMessagePayload record { + *MessagePayload; + string 'type?; + StateReference state?; + boolean force?; +}; + +public type CustomFieldDateType record { + *FieldType; + string name?; +}; + +public type ProductPriceExternalDiscountSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + int variantId?; + string variantKey?; + string sku?; + string priceId?; + DiscountedPrice discounted?; + boolean staged?; +}; + +public type ShippingMethodChangeIsDefaultAction record { + *ShippingMethodUpdateAction; + string action?; + boolean isDefault?; +}; + +public type StateSetTransitionsAction record { + *StateUpdateAction; + string action?; + StateResourceIdentifier[] transitions?; +}; + +public type OrderImportedMessagePayload record { + *MessagePayload; + string 'type?; + Order 'order?; +}; + +public type CartSetDeleteDaysAfterLastModificationAction record { + *CartUpdateAction; + string action?; + int deleteDaysAfterLastModification?; +}; + +public type StagedOrderSetItemShippingAddressCustomFieldAction record { + *StagedOrderUpdateAction; + string action?; + string addressKey?; + string name?; + string|record {}|string[]|decimal|int|boolean value?; +}; + +public type MyCustomerUpdateAction record { + string action?; +}; + +public type MyCartSetLineItemShippingDetailsAction record { + *MyCartUpdateAction; + string action?; + string lineItemId?; + ItemShippingDetailsDraft shippingDetails?; +}; + +public type SuggestTokenizer record { + string 'type?; +}; + +public type CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction record { + *CartUpdateAction; + string action?; + string customLineItemId?; + ItemShippingTarget[] targetsDelta?; +}; + +public type CustomerGroup record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + string name?; + CustomFields custom?; +}; + +public type OrderDiscountCodeRemovedMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + DiscountCodeReference discountCode?; +}; + +public type HighPrecisionMoney record { + *TypedMoney; + MoneyType 'type?; + int fractionDigits?; + int centAmount?; + CurrencyCode currencyCode?; + int preciseAmount?; +}; + +public type OrderEditPreviewSuccess record { + *OrderEditResult; + string 'type?; + StagedOrder preview?; + MessagePayload[] messagePayloads?; +}; + +public type DiscountCodeUpdate record { + int 'version?; + DiscountCodeUpdateAction[] actions?; +}; + +public type DiscountCodeChangeCartDiscountsAction record { + *DiscountCodeUpdateAction; + string action?; + CartDiscountResourceIdentifier[] cartDiscounts?; +}; + +public type OrderEditPreviewFailure record { + *OrderEditResult; + string 'type?; + ErrorObject[] errors?; +}; + +public type MyCustomerSetMiddleNameAction record { + *MyCustomerUpdateAction; + string action?; + string middleName?; +}; + +public type ImageDimensions record { + int w?; + int h?; +}; + +public type CategoryPagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + Category[] results?; +}; + +public type CustomerAddressRemovedMessagePayload record { + *MessagePayload; + string 'type?; + Address address?; +}; + +public type MyShoppingListAddTextLineItemAction record { + *MyShoppingListUpdateAction; + string action?; + LocalizedString name?; + LocalizedString description?; + int quantity?; + string addedAt?; + CustomFieldsDraft custom?; +}; + +public type ParcelMeasurements record { + float heightInMillimeter?; + float lengthInMillimeter?; + float widthInMillimeter?; + float weightInGram?; +}; + +public type PagedQueryResponse record { + int 'limit?; + int count?; + int total?; + int offset?; + BaseResource[] results?; + record {} meta?; +}; + +public type Category record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + LocalizedString name?; + LocalizedString slug?; + LocalizedString description?; + CategoryReference[] ancestors?; + CategoryReference parent?; + string orderHint?; + string externalId?; + LocalizedString metaTitle?; + LocalizedString metaDescription?; + LocalizedString metaKeywords?; + CustomFields custom?; + Asset[] assets?; + string 'key?; +}; + +public type MyCustomerAddBillingAddressIdAction record { + *MyCustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; +}; + +public type OrderEditReference record { + *Reference; + ReferenceTypeId typeId?; + string id?; + OrderEdit obj?; +}; + +public type ShoppingListUpdate record { + int 'version?; + ShoppingListUpdateAction[] actions?; +}; + +public type ReplicaCartDraft record { + string|record {}|string[]|decimal|int|boolean reference?; + string 'key?; +}; + +public type ProductDiscountValueExternal record { + *ProductDiscountValue; + string 'type?; +}; + +public type OrderSetLocaleAction record { + *OrderUpdateAction; + string action?; + string locale?; +}; + +public type ProductSelectionProductAddedMessagePayload record { + *MessagePayload; + string 'type?; + ProductReference product?; +}; + +public type CustomerChangeAddressAction record { + *CustomerUpdateAction; + string action?; + string addressId?; + string addressKey?; + BaseAddress address?; +}; + +public type MissingTaxRateForCountryError record { + *ErrorObject; + string code?; + string message?; + string taxCategoryId?; + string country?; + string state?; +}; + +public type LocalizedString record { +}; + +public type ProductTypeChangeAttributeConstraintAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + AttributeConstraintEnumDraft newValue?; +}; + +public type ZoneUpdate record { + int 'version?; + ZoneUpdateAction[] actions?; +}; + +public type ProductTypeChangeAttributeNameAction record { + *ProductTypeUpdateAction; + string action?; + string attributeName?; + string newAttributeName?; +}; + +public type ShoppingListSetLineItemCustomTypeAction record { + *ShoppingListUpdateAction; + string action?; + string lineItemId?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type CustomFieldStringType record { + *FieldType; + string name?; +}; + +public type MyCartDraft record { + CurrencyCode currency?; + string customerEmail?; + string country?; + InventoryMode inventoryMode?; + MyLineItemDraft[] lineItems?; + BaseAddress shippingAddress?; + BaseAddress billingAddress?; + ShippingMethodResourceIdentifier shippingMethod?; + CustomFieldsDraft custom?; + string locale?; + TaxMode taxMode?; + int deleteDaysAfterLastModification?; + BaseAddress[] itemShippingAddresses?; + StoreKeyReference store?; + DiscountCodeInfo[] discountCodes?; +}; + +public type CategoryChangeAssetOrderAction record { + *CategoryUpdateAction; + string action?; + string[] assetOrder?; +}; + +public type OrderCustomerEmailSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string email?; + string oldEmail?; +}; + +public type OrderCustomLineItemDiscountSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string customLineItemId?; + DiscountedLineItemPriceForQuantity[] discountedPricePerQuantity?; + TaxedItemPrice taxedPrice?; +}; + +public type ReviewRatingSetMessagePayload record { + *MessagePayload; + string 'type?; + float oldRating?; + float newRating?; + boolean includedInStatistics?; + Reference target?; +}; + +public type TaxCategoryChangeNameAction record { + *TaxCategoryUpdateAction; + string action?; + string name?; +}; + +public type TypeSetDescriptionAction record { + *TypeUpdateAction; + string action?; + LocalizedString description?; +}; + +public type CustomerSetCustomerNumberAction record { + *CustomerUpdateAction; + string action?; + string customerNumber?; +}; + +public type MyPaymentUpdateAction record { + string action?; +}; + +public type StagedOrderUpdateAction record { + string action?; +}; + +public type OrderTransitionLineItemStateAction record { + *OrderUpdateAction; + string action?; + string lineItemId?; + int quantity?; + StateResourceIdentifier fromState?; + StateResourceIdentifier toState?; + string actualTransitionDate?; +}; + +public type MyCustomerAddAddressAction record { + *MyCustomerUpdateAction; + string action?; + BaseAddress address?; +}; + +public type CustomerCompanyNameSetMessage record { + *Message; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + int sequenceNumber?; + Reference 'resource?; + int resourceVersion?; + string 'type?; + UserProvidedIdentifiers resourceUserProvidedIdentifiers?; + string companyName?; +}; + +public type CustomerSetTitleAction record { + *CustomerUpdateAction; + string action?; + string title?; +}; + +public type PendingOperationError record { + *ErrorObject; + string code?; + string message?; +}; + +public type MessagePayload record { + string 'type?; +}; + +public type ProjectChangeCountryTaxRateFallbackEnabledAction record { + *ProjectUpdateAction; + string action?; + boolean countryTaxRateFallbackEnabled?; +}; + +public type URLEncodedPayload record { +}; + +public type MyShoppingListUpdate record { + int 'version?; + MyShoppingListUpdateAction[] actions?; +}; + +public type PriceDraft record { + Money value?; + CountryCode country?; + CustomerGroupResourceIdentifier customerGroup?; + ChannelResourceIdentifier 'channel?; + string validFrom?; + string validUntil?; + CustomFieldsDraft custom?; + PriceTierDraft[] tiers?; + DiscountedPriceDraft discounted?; +}; + +public type ExtensionNoResponseError record { + *ErrorObject; + string code?; + string message?; + string extensionId?; + string extensionKey?; +}; + +public type Zone record { + *BaseResource; + string id?; + int 'version?; + string createdAt?; + string lastModifiedAt?; + LastModifiedBy lastModifiedBy?; + CreatedBy createdBy?; + string 'key?; + string name?; + string description?; + Location[] locations?; +}; + +public type ReviewSetTargetAction record { + *ReviewUpdateAction; + string action?; + string|record {}|string[]|decimal|int|boolean target?; +}; + +public type BaseAddress record { + string id?; + string 'key?; + string title?; + string salutation?; + string firstName?; + string lastName?; + string streetName?; + string streetNumber?; + string additionalStreetInfo?; + string postalCode?; + string city?; + string region?; + string state?; + CountryCode country?; + string company?; + string department?; + string building?; + string apartment?; + string pOBox?; + string phone?; + string mobile?; + string email?; + string fax?; + string additionalAddressInfo?; + string externalId?; +}; + +public type InvalidFieldError record { + *ErrorObject; + string code?; + string message?; + string 'field?; + string|record {}|string[]|decimal|int|boolean invalidValue?; + (string|record {}|string[]|decimal|int|boolean)[] allowedValues?; +}; + +public type ErrorByExtension record { + string id?; + string 'key?; +}; + +public type ExtensionUpdateAction record { + string action?; +}; + +public type DiscountCodeSetCustomTypeAction record { + *DiscountCodeUpdateAction; + string action?; + TypeResourceIdentifier 'type?; + FieldContainer fields?; +}; + +public type ShippingMethodAddShippingRateAction record { + *ShippingMethodUpdateAction; + string action?; + ZoneResourceIdentifier zone?; + ShippingRateDraft shippingRate?; +}; + +public type ReviewSetRatingAction record { + *ReviewUpdateAction; + string action?; + int rating?; +}; + +public type CustomerLastNameSetMessagePayload record { + *MessagePayload; + string 'type?; + string lastName?; +}; + +public type OrderSetOrderNumberAction record { + *OrderUpdateAction; + string action?; + string orderNumber?; +}; + +public type AttributeReferenceType record { + *AttributeType; + string name?; + ReferenceTypeId referenceTypeId?; +}; + +public type ProductPriceDiscountsSetUpdatedPrice record { + int variantId?; + string variantKey?; + string sku?; + string priceId?; + DiscountedPrice discounted?; + boolean staged?; +}; diff --git a/openapi/commercetools/utils.bal b/openapi/commercetools/utils.bal new file mode 100644 index 000000000..30a4625fc --- /dev/null +++ b/openapi/commercetools/utils.bal @@ -0,0 +1,245 @@ +// Copyright (c) 2022 WSO2 Inc. (http://www.wso2.org) All Rights Reserved. +// +// WSO2 Inc. licenses this file to you under the Apache License, +// Version 2.0 (the "License"); you may not use this file except +// in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +import ballerina/url; + +type SimpleBasicType string|boolean|int|float|decimal; + +# Represents encoding mechanism details. +type Encoding record { + # Defines how multiple values are delimited + string style = FORM; + # Specifies whether arrays and objects should generate as separate fields + boolean explode = true; + # Specifies the custom content type + string contentType?; + # Specifies the custom headers + map headers?; +}; + +enum EncodingStyle { + DEEPOBJECT, + FORM, + SPACEDELIMITED, + PIPEDELIMITED +} + +final Encoding & readonly defaultEncoding = {}; + +# Generate client request when the media type is given as application/x-www-form-urlencoded. +# +# + encodingMap - Includes the information about the encoding mechanism +# + anyRecord - Record to be serialized +# + return - Serialized request body or query parameter as a string +isolated function createFormURLEncodedRequestBody(record {|anydata...; |} anyRecord, map encodingMap = {}) returns string { + string[] payload = []; + foreach [string, anydata] [key, value] in anyRecord.entries() { + Encoding encodingData = encodingMap.hasKey(key) ? encodingMap.get(key) : defaultEncoding; + if value is SimpleBasicType { + payload.push(key, "=", getEncodedUri(value.toString())); + } else if value is SimpleBasicType[] { + payload.push(getSerializedArray(key, value, encodingData.style, encodingData.explode)); + } else if (value is record {}) { + if encodingData.style == DEEPOBJECT { + payload.push(getDeepObjectStyleRequest(key, value)); + } else { + payload.push(getFormStyleRequest(key, value)); + } + } else if (value is record {}[]) { + payload.push(getSerializedRecordArray(key, value, encodingData.style, encodingData.explode)); + } + payload.push("&"); + } + _ = payload.pop(); + return string:'join("", ...payload); +} + +# Serialize the record according to the deepObject style. +# +# + parent - Parent record name +# + anyRecord - Record to be serialized +# + return - Serialized record as a string +isolated function getDeepObjectStyleRequest(string parent, record {} anyRecord) returns string { + string[] recordArray = []; + foreach [string, anydata] [key, value] in anyRecord.entries() { + if value is SimpleBasicType { + recordArray.push(parent + "[" + key + "]" + "=" + getEncodedUri(value.toString())); + } else if value is SimpleBasicType[] { + recordArray.push(getSerializedArray(parent + "[" + key + "]" + "[]", value, DEEPOBJECT, true)); + } else if value is record {} { + string nextParent = parent + "[" + key + "]"; + recordArray.push(getDeepObjectStyleRequest(nextParent, value)); + } else if value is record {}[] { + string nextParent = parent + "[" + key + "]"; + recordArray.push(getSerializedRecordArray(nextParent, value, DEEPOBJECT)); + } + recordArray.push("&"); + } + _ = recordArray.pop(); + return string:'join("", ...recordArray); +} + +# Serialize the record according to the form style. +# +# + parent - Parent record name +# + anyRecord - Record to be serialized +# + explode - Specifies whether arrays and objects should generate separate parameters +# + return - Serialized record as a string +isolated function getFormStyleRequest(string parent, record {} anyRecord, boolean explode = true) returns string { + string[] recordArray = []; + if explode { + foreach [string, anydata] [key, value] in anyRecord.entries() { + if (value is SimpleBasicType) { + recordArray.push(key, "=", getEncodedUri(value.toString())); + } else if (value is SimpleBasicType[]) { + recordArray.push(getSerializedArray(key, value, explode = explode)); + } else if (value is record {}) { + recordArray.push(getFormStyleRequest(parent, value, explode)); + } + recordArray.push("&"); + } + _ = recordArray.pop(); + } else { + foreach [string, anydata] [key, value] in anyRecord.entries() { + if (value is SimpleBasicType) { + recordArray.push(key, ",", getEncodedUri(value.toString())); + } else if (value is SimpleBasicType[]) { + recordArray.push(getSerializedArray(key, value, explode = false)); + } else if (value is record {}) { + recordArray.push(getFormStyleRequest(parent, value, explode)); + } + recordArray.push(","); + } + _ = recordArray.pop(); + } + return string:'join("", ...recordArray); +} + +# Serialize arrays. +# +# + arrayName - Name of the field with arrays +# + anyArray - Array to be serialized +# + style - Defines how multiple values are delimited +# + explode - Specifies whether arrays and objects should generate separate parameters +# + return - Serialized array as a string +isolated function getSerializedArray(string arrayName, anydata[] anyArray, string style = "form", boolean explode = true) returns string { + string key = arrayName; + string[] arrayValues = []; + if (anyArray.length() > 0) { + if (style == FORM && !explode) { + arrayValues.push(key, "="); + foreach anydata i in anyArray { + arrayValues.push(getEncodedUri(i.toString()), ","); + } + } else if (style == SPACEDELIMITED && !explode) { + arrayValues.push(key, "="); + foreach anydata i in anyArray { + arrayValues.push(getEncodedUri(i.toString()), "%20"); + } + } else if (style == PIPEDELIMITED && !explode) { + arrayValues.push(key, "="); + foreach anydata i in anyArray { + arrayValues.push(getEncodedUri(i.toString()), "|"); + } + } else if (style == DEEPOBJECT) { + foreach anydata i in anyArray { + arrayValues.push(key, "[]", "=", getEncodedUri(i.toString()), "&"); + } + } else { + foreach anydata i in anyArray { + arrayValues.push(key, "=", getEncodedUri(i.toString()), "&"); + } + } + _ = arrayValues.pop(); + } + return string:'join("", ...arrayValues); +} + +# Serialize the array of records according to the form style. +# +# + parent - Parent record name +# + value - Array of records to be serialized +# + style - Defines how multiple values are delimited +# + explode - Specifies whether arrays and objects should generate separate parameters +# + return - Serialized record as a string +isolated function getSerializedRecordArray(string parent, record {}[] value, string style = FORM, boolean explode = true) returns string { + string[] serializedArray = []; + if style == DEEPOBJECT { + int arayIndex = 0; + foreach var recordItem in value { + serializedArray.push(getDeepObjectStyleRequest(parent + "[" + arayIndex.toString() + "]", recordItem), "&"); + arayIndex = arayIndex + 1; + } + } else { + if (!explode) { + serializedArray.push(parent, "="); + } + foreach var recordItem in value { + serializedArray.push(getFormStyleRequest(parent, recordItem, explode), ","); + } + } + _ = serializedArray.pop(); + return string:'join("", ...serializedArray); +} + +# Get Encoded URI for a given value. +# +# + value - Value to be encoded +# + return - Encoded string +isolated function getEncodedUri(string value) returns string { + string|error encoded = url:encode(value, "UTF8"); + if (encoded is string) { + return encoded; + } else { + return value; + } +} + +# Generate query path with query parameter. +# +# + queryParam - Query parameter map +# + encodingMap - Details on serialization mechanism +# + return - Returns generated Path or error at failure of client initialization +isolated function getPathForQueryParam(map queryParam, map encodingMap = {}) returns string|error { + string[] param = []; + if (queryParam.length() > 0) { + param.push("?"); + foreach var [key, value] in queryParam.entries() { + if value is () { + _ = queryParam.remove(key); + continue; + } + Encoding encodingData = encodingMap.hasKey(key) ? encodingMap.get(key) : defaultEncoding; + if (value is SimpleBasicType) { + param.push(key, "=", getEncodedUri(value.toString())); + } else if (value is SimpleBasicType[]) { + param.push(getSerializedArray(key, value, encodingData.style, encodingData.explode)); + } else if (value is record {}) { + if (encodingData.style == DEEPOBJECT) { + param.push(getDeepObjectStyleRequest(key, value)); + } else { + param.push(getFormStyleRequest(key, value, encodingData.explode)); + } + } else { + param.push(key, "=", value.toString()); + } + param.push("&"); + } + _ = param.pop(); + } + string restOfPath = string:'join("", ...param); + return restOfPath; +}