From 5d99b27018eab836e89c2cdff377c7942463308b Mon Sep 17 00:00:00 2001 From: Auto Mation Date: Wed, 18 Oct 2023 11:51:47 +0000 Subject: [PATCH] TASK: Updating RAML types, Postman and OAS definition --- oas/api/openapi.yaml | 5426 ++++++++++++++++++++++++++++++++++++-- oas/history/openapi.yaml | 4 +- uml/api/_index.puml | 658 ++++- uml/api/svg/_index.svg | 660 ++++- 4 files changed, 6491 insertions(+), 257 deletions(-) diff --git a/oas/api/openapi.yaml b/oas/api/openapi.yaml index d11530b9c..a25e08546 100644 --- a/oas/api/openapi.yaml +++ b/oas/api/openapi.yaml @@ -57,6 +57,18 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_project_settings:{projectKey}" + operationId: ByProjectKeyHead + description: |- + Checks if a Project exists for a given `projectKey`. Returns a `200 OK` status if the Project exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} post: security: - oauth_2_0: @@ -177,6 +189,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_api_clients:{projectKey}" + operationId: ByProjectKeyApiClientsHead + description: |- + Checks if an API Client exists for a given Query Predicate. Returns a `200 OK` status if any API Clients match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -261,6 +309,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_api_clients:{projectKey}" + operationId: ByProjectKeyApiClientsByIDHead + description: |- + Checks if an API Client exists for a given `id`. Returns a `200 OK` status if the API Client exists or a `404 Not Found` otherwise. + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} delete: security: - oauth_2_0: @@ -392,6 +466,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_business_units:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdBusinessUnitsHead + description: |- + Checks if a BusinessUnit exists for a given Query Predicate. Returns a `200 OK` status if any BusinessUnits match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -491,6 +601,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_business_units:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdBusinessUnitsKeyByKeyHead + description: |- + Checks if a BusinessUnit exists for a given `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -592,6 +728,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_business_units:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdBusinessUnitsByIDHead + description: |- + Checks if a BusinessUnit exists for a given `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -1325,6 +1487,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsHead + description: |- + Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -1434,6 +1632,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsKeyByKeyHead + description: |- + Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -1660,6 +1884,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyCartsByIDHead + description: |- + Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -1871,38 +2121,74 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: security: - oauth_2_0: - - "manage_orders:{projectKey}" - operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost + - "view_orders:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersHead description: |- - Creates an Order from a [Cart](ctp:api:type:Cart) in a [BusinessUnit](ctp:api:type:BusinessUnit). - The Cart must have a shipping address set before creating an Order. - Creating an Order fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Cart does not reference the same BusinessUnit as the `businessUnitKey` path parameter. + Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise. parameters: - - name: expand + - name: where in: query required: false style: form schema: type: "array" items: - $ref: '#/components/schemas/Expansion' + $ref: '#/components/schemas/QueryPredicate' explode: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OrderFromCartDraft' - responses: - "201": + "200": description: |- - 201 - content: - application/json: - schema: + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersPost + description: |- + Creates an Order from a [Cart](ctp:api:type:Cart) in a [BusinessUnit](ctp:api:type:BusinessUnit). + The Cart must have a shipping address set before creating an Order. + Creating an Order fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) if the Cart does not reference the same BusinessUnit as the `businessUnitKey` 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/OrderFromCartDraft' + + responses: + "201": + description: |- + 201 + content: + application/json: + schema: $ref: '#/components/schemas/Order' "400": @@ -1981,6 +2267,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersOrderNumberByOrderNumberHead + description: |- + Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -2145,6 +2457,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyOrdersByIDHead + description: |- + Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -2299,6 +2637,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_quote_requests:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsHead + description: |- + Checks if a QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -2407,6 +2781,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_quote_requests:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsKeyByKeyHead + description: |- + Checks if a QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -2517,6 +2917,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_quote_requests:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuoteRequestsByIDHead + description: |- + Checks if a QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -2673,6 +3099,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_quotes:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesHead + description: |- + Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/quotes/key={key}: parameters: - name: projectKey @@ -2735,6 +3197,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_quotes:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesKeyByKeyHead + description: |- + Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -2845,27 +3333,53 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: security: - oauth_2_0: - - "manage_quotes:{projectKey}" - operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDPost + - "view_quotes:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDHead description: |- - If the Quote exists in the [Project](ctp:api:type:Project) but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) 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: + Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: + security: + - oauth_2_0: + - "manage_quotes:{projectKey}" + operationId: ByProjectKeyAsAssociateByAssociateIdInBusinessUnitKeyByBusinessUnitKeyQuotesByIDPost + description: |- + If the Quote exists in the [Project](ctp:api:type:Project) but does not reference the requested [BusinessUnit](ctp:api:type:BusinessUnit), this method returns an [InvalidOperation](ctp:api:type:InvalidOperationError) 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/QuoteUpdate' responses: @@ -2991,6 +3505,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_associate_roles:{projectKey}" + operationId: ByProjectKeyAssociateRolesHead + description: |- + Checks if an AssociateRole exists for a given Query Predicate. Returns a `200 OK` status if any AssociateRole match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -3087,6 +3637,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_associate_roles:{projectKey}" + operationId: ByProjectKeyAssociateRolesKeyByKeyHead + description: |- + Checks if an AssociateRole exists for a given `key`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -3233,6 +3809,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_associate_roles:{projectKey}" + operationId: ByProjectKeyAssociateRolesByIDHead + description: |- + Checks if an AssociateRole exists for a given `id`. Returns a `200 OK` status if the AssociateRole exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -3425,6 +4027,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_attribute_groups:{projectKey}" + operationId: ByProjectKeyAttributeGroupsHead + description: |- + Checks if an AttributeGroup exists for a given Query Predicate. Returns `200 OK` status if any AttributeGroups match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -3519,6 +4157,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_attribute_groups:{projectKey}" + operationId: ByProjectKeyAttributeGroupsKeyByKeyHead + description: |- + Checks if an AttributeGroup exists for a given `key`. Returns `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -3663,6 +4327,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_attribute_groups:{projectKey}" + operationId: ByProjectKeyAttributeGroupsByIDHead + description: |- + Checks if an AttributeGroup exists for a given `id`. Returns a `200 OK` status if the AttributeGroup exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -3855,6 +4545,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_business_units:{projectKey}" + operationId: ByProjectKeyBusinessUnitsHead + description: |- + Checks if a BusinessUnit exists for a given Query Predicate. Returns a `200 OK` status if any BusinessUnits match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -3949,25 +4675,51 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: security: - oauth_2_0: - - "manage_business_units:{projectKey}" - operationId: ByProjectKeyBusinessUnitsKeyByKeyPost - parameters: - - name: expand - in: query - required: false - style: form - schema: - type: "array" - items: - $ref: '#/components/schemas/Expansion' - explode: true - requestBody: - content: - application/json: - schema: + - "view_business_units:{projectKey}" + operationId: ByProjectKeyBusinessUnitsKeyByKeyHead + description: |- + Checks if a BusinessUnit exists for a given `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: + security: + - oauth_2_0: + - "manage_business_units:{projectKey}" + operationId: ByProjectKeyBusinessUnitsKeyByKeyPost + 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/BusinessUnitUpdate' responses: @@ -4093,6 +4845,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_business_units:{projectKey}" + operationId: ByProjectKeyBusinessUnitsByIDHead + description: |- + Checks if a BusinessUnit exists for a given `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -4286,6 +5064,43 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_cart_discounts:{projectKey}" + operationId: ByProjectKeyCartDiscountsHead + description: |- + Checks if a CartDiscount exists for a given Query Predicate. Returns a `200 OK` status if any CartDiscounts match the Query Predicate, or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -4382,6 +5197,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_cart_discounts:{projectKey}" + operationId: ByProjectKeyCartDiscountsKeyByKeyHead + description: |- + Checks if a CartDiscount exists for a given `key`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -4529,6 +5371,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_cart_discounts:{projectKey}" + operationId: ByProjectKeyCartDiscountsByIDHead + description: |- + Checks if a CartDiscount exists for a given `id`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -4723,6 +5592,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyCartsHead + description: |- + Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate, or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -4825,6 +5730,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyCartsCustomerIdByCustomerIdHead + description: |- + Checks if a Cart of a Customer exists. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/carts/key={key}: parameters: - name: projectKey @@ -4877,6 +5808,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyCartsKeyByKeyHead + description: |- + Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -5077,6 +6034,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyCartsByIDHead + description: |- + Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -5279,7 +6262,44 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_categories:{projectKey}" + operationId: ByProjectKeyCategoriesHead + description: |- + Checks if a Category exists for on a given Query Predicate. Returns a `200 OK` status if any Categories match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: security: - oauth_2_0: - "manage_products:{projectKey}" @@ -5381,6 +6401,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_categories:{projectKey}" + operationId: ByProjectKeyCategoriesKeyByKeyHead + description: |- + Checks if a Category exists for a given `key`. Returns a `200 OK` status if the Category exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -5534,6 +6581,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_categories:{projectKey}" + operationId: ByProjectKeyCategoriesByIDHead + description: |- + Checks if a Category exists for a given `id`. Returns a `200 OK` status if the Category exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -5732,6 +6806,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyChannelsHead + description: |- + Checks if a Channel exists for a given Query Predicate. Returns a `200 OK` status if any Channels match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -5826,6 +6936,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyChannelsByIDHead + description: |- + Checks if a Channel exists for a given `id`. Returns a `200 OK` status if the Channel exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -6023,6 +7159,45 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_orders:{projectKey}" + - "view_customers:{projectKey}" + - "view_key_value_documents:{projectKey}" + operationId: ByProjectKeyCustomObjectsHead + description: |- + Checks if a CustomObject exists for a given Query Predicate. Returns a `200 OK` status if any CustomObjects match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -6402,6 +7577,43 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customer_groups:{projectKey}" + operationId: ByProjectKeyCustomerGroupsHead + description: |- + Checks if a CustomerGroup exists for a given Query Predicate. Returns a `200 OK` status if any CustomerGroup match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -6498,6 +7710,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customer_groups:{projectKey}" + operationId: ByProjectKeyCustomerGroupsKeyByKeyHead + description: |- + Checks if a CustomerGroup exists for a given `key`. Returns a `200 OK` status if the CustomerGroup exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -6646,22 +7885,49 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: 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 + - "view_customers:{projectKey}" + - "view_customer_groups:{projectKey}" + operationId: ByProjectKeyCustomerGroupsByIDHead + description: |- + Checks if a CustomerGroup exists for a given `id`. Returns a `200 OK` status if the CustomerGroup exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: + 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: @@ -6840,6 +8106,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_customers:{projectKey}" + operationId: ByProjectKeyCustomersHead + description: |- + Checks if a Customer exists for a given Query Predicate. Returns a `200 OK` status if any Customers match the Query Predicate, or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -7074,6 +8376,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_customers:{projectKey}" + operationId: ByProjectKeyCustomersKeyByKeyHead + description: |- + Checks if a Customer exists for a given `key`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -7406,6 +8734,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_customers:{projectKey}" + operationId: ByProjectKeyCustomersByIDHead + description: |- + Checks if a Customer exists for a given `id`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -7609,6 +8963,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_discount_codes:{projectKey}" + operationId: ByProjectKeyDiscountCodesHead + description: |- + Checks if a DiscountCode exists for a given Query Predicate. Returns a `200 OK` status if any DiscountCodes match the Query Predicate, or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -7707,6 +9097,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_discount_codes:{projectKey}" + operationId: ByProjectKeyDiscountCodesByIDHead + description: |- + Checks if a DiscountCode exists for a given `id`. Returns a `200 OK` status if the DiscountCode exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -7901,6 +9317,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_extensions:{projectKey}" + operationId: ByProjectKeyExtensionsHead + description: |- + Checks if an Extension exists for a given Query Predicate. Returns a `200 OK` status if any Extensions match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} post: security: - oauth_2_0: @@ -7975,6 +9427,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_extensions:{projectKey}" + operationId: ByProjectKeyExtensionsKeyByKeyHead + description: |- + Checks if an Extension exists for a given `key`. Returns a `200 OK` status if the Extension exists or a `404 Not Found` otherwise. + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} post: security: - oauth_2_0: @@ -8090,28 +9568,54 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: security: - oauth_2_0: - "manage_extensions:{projectKey}" - operationId: ByProjectKeyExtensionsByIDPost - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionUpdate' - + operationId: ByProjectKeyExtensionsByIDHead + description: |- + Checks if an Extension exists for a given `id`. Returns a `200 OK` status if the Extension exists or a `404 Not Found` otherwise. responses: - "200": - description: |- - 200 - content: - application/json: - schema: - $ref: '#/components/schemas/Extension' - - "409": - $ref: '#/components/responses/conflicting_409' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} + post: + security: + - oauth_2_0: + - "manage_extensions:{projectKey}" + operationId: ByProjectKeyExtensionsByIDPost + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExtensionUpdate' + + responses: + "200": + description: |- + 200 + content: + application/json: + schema: + $ref: '#/components/schemas/Extension' + + "409": + $ref: '#/components/responses/conflicting_409' "400": $ref: '#/components/responses/errorable_400' "401": @@ -8275,6 +9779,27 @@ paths: schema: $ref: '#/components/schemas/CartDiscount' + head: + security: + - oauth_2_0: + - "manage_orders:{projectKey}" + - "manage_orders:{projectKey}:{storeKey}" + - "manage_cart_discounts:{projectKey}" + - "manage_cart_discounts:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartDiscountsHead + description: |- + Checks if a CartDiscount exists for a given Query Predicate. Returns a `200 OK` status if any CartDiscounts match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: post: security: - oauth_2_0: @@ -8358,6 +9883,35 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + - "view_cart_discounts:{projectKey}" + - "view_cart_discounts:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartDiscountsKeyByKeyHead + description: |- + Checks if a CartDiscount exists for a given `key`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -8521,6 +10075,35 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + - "view_cart_discounts:{projectKey}" + - "view_cart_discounts:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartDiscountsByIDHead + description: |- + Checks if a CartDiscount exists for a given `id`. Returns a `200 OK` status if the CartDiscount exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -8731,6 +10314,43 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsHead + description: |- + Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -8842,6 +10462,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsCustomerIdByCustomerIdHead + description: |- + Checks if a Cart of a Customer exists. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/in-store/key={storeKey}/carts/key={key}: parameters: - name: projectKey @@ -8902,6 +10549,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsKeyByKeyHead + description: |- + Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -9122,6 +10796,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCartsByIDHead + description: |- + Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -9335,46 +11036,83 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: security: - oauth_2_0: - - "manage_customers:{projectKey}" - - "manage_customers:{projectKey}:{storeKey}" - operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersPost + - "view_customers:{projectKey}" + - "view_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersHead description: |- - When using this endpoint, if omitted, the Customer `stores` field is set to the [Store](ctp:api:type:Store) specified in the path parameter. - - If the `anonymousCart` field is set on the [CustomerDraft](ctp:api:type:CustomerDraft), then the newly created Customer will be assigned to that [Cart](ctp:api:type:Cart). - Similarly, if the `anonymousId` field is set, the Customer will be set on all [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [ShoppingLists](ctp:api:type:ShoppingList) and [Payments](ctp:api:type:Payment) with the same `anonymousId`. - If a Cart with a `store` field specified, the `store` field must reference the same [Store](ctp:api:type:Store) specified in the `{storeKey}` path parameter. - Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) Message. + Checks if a Customer exists for a given Query Predicate. Returns a `200 OK` status if any Customers match the Query Predicate or a `404 Not Found` otherwise. parameters: - - name: expand + - name: where in: query required: false style: form schema: type: "array" items: - $ref: '#/components/schemas/Expansion' + $ref: '#/components/schemas/QueryPredicate' explode: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CustomerDraft' - responses: - "201": + "200": description: |- - 201 - content: - application/json: - schema: - $ref: '#/components/schemas/CustomerSignInResult' - - "400": - $ref: '#/components/responses/errorable_400' + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: + security: + - oauth_2_0: + - "manage_customers:{projectKey}" + - "manage_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersPost + description: |- + When using this endpoint, if omitted, the Customer `stores` field is set to the [Store](ctp:api:type:Store) specified in the path parameter. + + If the `anonymousCart` field is set on the [CustomerDraft](ctp:api:type:CustomerDraft), then the newly created Customer will be assigned to that [Cart](ctp:api:type:Cart). + Similarly, if the `anonymousId` field is set, the Customer will be set on all [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [ShoppingLists](ctp:api:type:ShoppingList) and [Payments](ctp:api:type:Payment) with the same `anonymousId`. + If a Cart with a `store` field specified, the `store` field must reference the same [Store](ctp:api:type:Store) specified in the `{storeKey}` path parameter. + Creating a Customer produces the [CustomerCreated](ctp:api:type:CustomerCreatedMessage) 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/CustomerDraft' + + responses: + "201": + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/CustomerSignInResult' + + "400": + $ref: '#/components/responses/errorable_400' "401": $ref: '#/components/responses/errorable_401' "403": @@ -9604,6 +11342,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersKeyByKeyHead + description: |- + Checks if a Customer exists for a given `key`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -9978,6 +11743,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_customers:{projectKey}" + - "view_customers:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyCustomersByIDHead + description: |- + Checks if a Customer exists for a given `id`. Returns a `200 OK` status if the Customer exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -10332,6 +12124,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeActiveCartHead + description: |- + Checks if an active Cart exists. Returns a `200 OK` status if an active Cart exists or a `404 Not Found` otherwise. + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} /{projectKey}/in-store/key={storeKey}/me/carts: description: |- A shopping cart holds product variants and can be ordered. @@ -10436,6 +12255,43 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeCartsHead + description: |- + Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -10541,6 +12397,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeCartsByIDHead + description: |- + Checks ifa My Cart exists for a given `id`. Returns a `200 OK` status if the My Cart exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -10848,6 +12731,43 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeOrdersHead + description: |- + Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -10965,6 +12885,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeOrdersByIDHead + description: |- + Checks if an Order exists for a given `id`. Returns a `200 OK` status if the My Order exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/in-store/key={storeKey}/me/password: parameters: - name: projectKey @@ -11171,16 +13118,53 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: security: - oauth_2_0: - "manage_my_shopping_lists:{projectKey}" - "manage_my_shopping_lists:{projectKey}:{storeKey}" - operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPost + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsHead description: |- - When using this endpoint, the `store` field of a ShoppingList is always set to the [Store](ctp:api:type:Store) specified in the path parameter. + Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise. parameters: - - name: expand + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + - "manage_my_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsPost + description: |- + When using this endpoint, the `store` field of a ShoppingList is always set to the [Store](ctp:api:type:Store) specified in the path parameter. + parameters: + - name: expand in: query required: false style: form @@ -11276,6 +13260,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + - "manage_my_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsKeyByKeyHead + description: |- + Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -11444,6 +13455,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}:{storeKey}" + - "manage_my_shopping_lists:{projectKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsByIDHead + description: |- + Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -11708,6 +13746,43 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyOrdersHead + description: |- + Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -11827,6 +13902,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyOrdersOrderNumberByOrderNumberHead + description: |- + Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -11994,6 +14096,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyOrdersByIDHead + description: |- + Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -12211,6 +14340,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyProductProjectionsKeyByKeyHead + description: |- + Checks if the current or staged representations of a Product exists for a given `key` in the specified [Store](ctp:api:type:Store). Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/in-store/key={storeKey}/product-projections/{ID}: parameters: - name: projectKey @@ -12319,6 +14475,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyProductProjectionsByIDHead + description: |- + Checks if the current or staged representations of a Product exists for a given `id` in the specified [Store](ctp:api:type:Store). Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/in-store/key={storeKey}/product-selection-assignments: parameters: - name: projectKey @@ -12486,35 +14669,74 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - /{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: + head: security: - oauth_2_0: - - "view_shopping_lists:{projectKey}" - - "view_shopping_lists:{projectKey}:{storeKey}" - operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsGet + - "view_orders:{projectKey}" + - "view_orders:{projectKey}:{storeKey}" + - "manage_customers:{projectKey}:{storeKey}" + - "view_shipping_methods:{projectKey}" + - "manage_my_orders:{projectKey}" + - "manage_my_orders:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShippingMethodsMatchingCartHead + description: |- + Checks if a ShippingMethod that can ship to the shipping address of the given Cart exists in the given [Store](ctp:api:type:Store). Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise. parameters: - - name: expand + - name: cartId in: query - required: false + required: true style: form schema: - type: "array" - items: - $ref: '#/components/schemas/Expansion' + type: "string" + explode: true + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} + /{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: + 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 @@ -12590,6 +14812,43 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + - "view_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsHead + description: |- + Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -12696,6 +14955,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + - "view_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsKeyByKeyHead + description: |- + Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -12864,6 +15150,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + - "view_shopping_lists:{projectKey}:{storeKey}" + operationId: ByProjectKeyInStoreKeyByStoreKeyShoppingListsByIDHead + description: |- + Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -13071,6 +15384,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyInventoryHead + description: |- + Checks if an InventoryEntry exists for a given Query Predicate. Returns a `200 OK` status if any Inventory Entries match the Query Predicate, a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -13167,6 +15516,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyInventoryKeyByKeyHead + description: |- + Checks if an InventoryEntry exists for a given `key`. Returns a `200 OK` status if the InventoryEntry exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -13313,6 +15688,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyInventoryByIDHead + description: |- + Checks if an InventoryEntry exists for a given `id`. Returns a `200 OK` status if the InventoryEntry exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -13677,6 +16078,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeActiveCartHead + description: |- + Checks if an active Cart exists. Returns a `200 OK` status if an active Cart exists or a `404 Not Found` otherwise. + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} /{projectKey}/me/business-units: description: |- MyBusinessUnit creates and provides access to Business Units scoped to a specific user. @@ -13775,31 +16202,67 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: security: - oauth_2_0: - "manage_my_business_units:{projectKey}" - operationId: ByProjectKeyMeBusinessUnitsPost + operationId: ByProjectKeyMeBusinessUnitsHead description: |- - Automatically assigns the Associate to the Business Unit in the default [Associate Role](ctp:api:type:AssociateRole) defined in [BusinessUnitConfiguration](ctp:api:type:BusinessUnitConfiguration). If there is no default Associate Role configured, this request fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) error. When creating a Division, the Associate must have the `AddChildUnits` [Permission](ctp:api:type:Permission) in the parent unit. If the required [Permission](/projects/associate-roles#permission) is missing, an [AssociateMissingPermission](/errors#associatemissingpermission) error is returned. + Checks if a BusinessUnit exists for a given Query Predicate. Returns a `200 OK` status if any BusinessUnits match the Query Predicate or a `404 Not Found` otherwise. parameters: - - name: expand + - name: where in: query required: false style: form schema: type: "array" items: - $ref: '#/components/schemas/Expansion' + $ref: '#/components/schemas/QueryPredicate' explode: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MyBusinessUnitDraft' - responses: - "201": + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: + security: + - oauth_2_0: + - "manage_my_business_units:{projectKey}" + operationId: ByProjectKeyMeBusinessUnitsPost + description: |- + Automatically assigns the Associate to the Business Unit in the default [Associate Role](ctp:api:type:AssociateRole) defined in [BusinessUnitConfiguration](ctp:api:type:BusinessUnitConfiguration). If there is no default Associate Role configured, this request fails with an [InvalidOperation](ctp:api:type:InvalidOperationError) error. When creating a Division, the Associate must have the `AddChildUnits` [Permission](ctp:api:type:Permission) in the parent unit. If the required [Permission](/projects/associate-roles#permission) is missing, an [AssociateMissingPermission](/errors#associatemissingpermission) error is returned. + 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/MyBusinessUnitDraft' + + responses: + "201": description: |- 201 content: @@ -13871,6 +16334,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_business_units:{projectKey}" + operationId: ByProjectKeyMeBusinessUnitsKeyByKeyHead + description: |- + Checks if a BusinessUnit exists for a given `key`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -14015,6 +16504,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_business_units:{projectKey}" + operationId: ByProjectKeyMeBusinessUnitsByIDHead + description: |- + Checks if a BusinessUnit exists for a given `id`. Returns a `200 OK` status if the BusinessUnit exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -14207,6 +16722,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeCartsHead + description: |- + Checks if a Cart exists for a given Query Predicate. Returns a `200 OK` status if any Carts match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -14301,6 +16852,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeCartsKeyByKeyHead + description: |- + Checks if a Cart exists for a given `key`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -14498,6 +17075,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeCartsByIDHead + description: |- + Checks if a Cart exists for a given `id`. Returns a `200 OK` status if the Cart exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -14785,6 +17388,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeOrdersHead + description: |- + Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -14945,6 +17584,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyMeOrdersByIDHead + description: |- + Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/me/password: parameters: - name: projectKey @@ -15135,41 +17800,77 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: security: - oauth_2_0: - "manage_my_payments:{projectKey}" - operationId: ByProjectKeyMePaymentsPost + operationId: ByProjectKeyMePaymentsHead description: |- - Creating a Payment produces the [PaymentCreated](ctp:api:type:PaymentCreatedMessage) Message. + Checks if a Payment exists for a given Query Predicate. Returns a `200 OK` status if any Payments match the Query Predicate or a `404 Not Found` otherwise. parameters: - - name: expand + - name: where in: query required: false style: form schema: type: "array" items: - $ref: '#/components/schemas/Expansion' + $ref: '#/components/schemas/QueryPredicate' explode: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MyPaymentDraft' - responses: - "201": + "200": description: |- - 201 - content: - application/json: - schema: - $ref: '#/components/schemas/MyPayment' - - "400": - $ref: '#/components/responses/errorable_400' - "401": + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: + security: + - oauth_2_0: + - "manage_my_payments:{projectKey}" + operationId: ByProjectKeyMePaymentsPost + description: |- + Creating a Payment produces the [PaymentCreated](ctp:api:type:PaymentCreatedMessage) 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/MyPaymentDraft' + + responses: + "201": + description: |- + 201 + content: + application/json: + schema: + $ref: '#/components/schemas/MyPayment' + + "400": + $ref: '#/components/responses/errorable_400' + "401": $ref: '#/components/responses/errorable_401' "403": $ref: '#/components/responses/errorable_403' @@ -15231,6 +17932,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_payments:{projectKey}" + operationId: ByProjectKeyMePaymentsByIDHead + description: |- + Checks if a Payment exists for a given `id`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -15427,6 +18154,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_quote_requests:{projectKey}" + operationId: ByProjectKeyMeQuoteRequestsHead + description: |- + Checks if my QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -15521,6 +18284,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_quote_requests:{projectKey}" + operationId: ByProjectKeyMeQuoteRequestsKeyByKeyHead + description: |- + Checks if my QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -15665,6 +18454,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_quote_requests:{projectKey}" + operationId: ByProjectKeyMeQuoteRequestsByIDHead + description: |- + Checks if my QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -15857,6 +18672,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_quotes:{projectKey}" + operationId: ByProjectKeyMeQuotesHead + description: |- + Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/me/quotes/key={key}: parameters: - name: projectKey @@ -15907,6 +18758,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_quotes:{projectKey}" + operationId: ByProjectKeyMeQuotesKeyByKeyHead + description: |- + Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -16003,6 +18880,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_quotes:{projectKey}" + operationId: ByProjectKeyMeQuotesByIDHead + description: |- + Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -16147,31 +19050,67 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: security: - oauth_2_0: - "manage_my_shopping_lists:{projectKey}" - operationId: ByProjectKeyMeShoppingListsPost + operationId: ByProjectKeyMeShoppingListsHead + description: |- + Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise. parameters: - - name: expand + - name: where in: query required: false style: form schema: type: "array" items: - $ref: '#/components/schemas/Expansion' + $ref: '#/components/schemas/QueryPredicate' explode: true - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/MyShoppingListDraft' - responses: - "201": + "200": description: |- - 201 + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: + 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: @@ -16241,6 +19180,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + operationId: ByProjectKeyMeShoppingListsKeyByKeyHead + description: |- + Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -16385,6 +19350,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_my_shopping_lists:{projectKey}" + operationId: ByProjectKeyMeShoppingListsByIDHead + description: |- + Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -16624,6 +19615,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_messages:{projectKey}" + operationId: ByProjectKeyMessagesHead + description: |- + Checks if a Message exists for a given Query Predicate. Returns a `200 OK` status if any Messages match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/messages/{ID}: parameters: - name: projectKey @@ -16676,6 +19703,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_messages:{projectKey}" + operationId: ByProjectKeyMessagesByIDHead + description: |- + Checks if a Message exists for a given `id`. Returns a `200 OK` status if the Message exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/orders: description: |- An order can be created from a order, usually after a checkout process has been completed. @@ -16774,6 +19827,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyOrdersHead + description: |- + Checks if an Order exists for a given Query Predicate. Returns a `200 OK` status if any Orders match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -16933,6 +20022,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsHead + description: |- + Checks if an OrderEdit exists for a given Query Predicate. Returns a `200 OK` status if any OrderEdits match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -17029,6 +20154,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsKeyByKeyHead + description: |- + Checks if an OrderEdit exists for a given `key`. Returns a `200 OK` status if the OrderEdit exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -17173,24 +20324,50 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: 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: + - "view_order_edits:{projectKey}" + operationId: ByProjectKeyOrdersEditsByIDHead + description: |- + Checks if an OrderEdit exists for a given `id`. Returns a `200 OK` status if the OrderEdit exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: + 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' @@ -17413,6 +20590,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyOrdersOrderNumberByOrderNumberHead + description: |- + Checks if an Order exists for a given `orderNumber`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -17686,6 +20889,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyOrdersByIDHead + description: |- + Checks if an Order exists for a given `id`. Returns a `200 OK` status if the Order exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -17887,6 +21116,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_payments:{projectKey}" + operationId: ByProjectKeyPaymentsHead + description: |- + Checks if a Payment exists for a given Query Predicate. Returns a `200 OK` status if any Payments match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -17983,6 +21248,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_payments:{projectKey}" + operationId: ByProjectKeyPaymentsKeyByKeyHead + description: |- + Checks if a Payment exists for a given `key`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -18134,6 +21425,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_payments:{projectKey}" + operationId: ByProjectKeyPaymentsByIDHead + description: |- + Checks if a Payment exists for a given `id`. Returns a `200 OK` status if the Payment exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -18333,6 +21650,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsHead + description: |- + Checks if a ProductDiscount exists for a given Query Predicate. Returns a `200 OK` status if any ProductDiscounts match the Query Predicate, or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -18427,6 +21780,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsKeyByKeyHead + description: |- + Checks if a ProductDiscount exists for a given `key`. Returns a `200 OK` status if the ProductDiscount exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -18617,6 +21996,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyProductDiscountsByIDHead + description: |- + Checks if a ProductDiscount exists for a given `id`. Returns a `200 OK` status if the ProductDiscount exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -18867,11 +22272,48 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - /{projectKey}/product-projections/key={key}: - parameters: - - name: projectKey - in: path - required: true + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyProductProjectionsHead + description: |- + Checks if the current or staged representation of a Product exists for a given Query Predicate. Returns a `200 OK` status if any ProductProjections match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + /{projectKey}/product-projections/key={key}: + parameters: + - name: projectKey + in: path + required: true schema: type: "string" - name: key @@ -18974,6 +22416,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyProductProjectionsKeyByKeyHead + description: |- + Checks if the current or staged representation of a Product exists for a given `key`. Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/product-projections/search: description: |- This endpoint provides high performance search queries over ProductProjections. The query result contains the @@ -19417,6 +22886,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_published_products:{projectKey}" + operationId: ByProjectKeyProductProjectionsByIDHead + description: |- + Checks if the current or staged representation of a Product exists for a given `id`. Returns a `200 OK` status if the ProductProjection exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' /{projectKey}/product-selections: description: |- Manage individual Store assortments through Product Selections. @@ -19521,6 +23017,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsHead + description: |- + Checks if a ProductSelection exists for a given Query Predicate. Returns a `200 OK` status if any ProductSelections match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -19615,6 +23147,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsKeyByKeyHead + description: |- + Checks if a ProductSelection exists for a given `key`. Returns a `200 OK` status if the ProductSelection exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -19845,6 +23403,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_product_selections:{projectKey}" + operationId: ByProjectKeyProductSelectionsByIDHead + description: |- + Checks if a ProductSelection exists for a given `id`. Returns a `200 OK` status if the ProductSelection exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -20130,7 +23714,7 @@ paths: - "view_products:{projectKey}" operationId: ByProjectKeyProductTypesHead description: |- - Check if Product Types exist. Responds with a `200 OK` status if any Product Types match the Query Predicate, or `404 Not Found` otherwise. + Checks if a ProductType exists for a given Query Predicate. Returns a `200 OK` status if any ProductTypes match the Query Predicate or a `404 Not Found` otherwise. parameters: - name: where in: query @@ -20142,7 +23726,7 @@ paths: responses: "200": description: |- - At least one ProductType matching the query exists + 200 content: {} "404": $ref: '#/components/responses/errorable_404' @@ -20258,11 +23842,11 @@ paths: - "view_products:{projectKey}" operationId: ByProjectKeyProductTypesKeyByKeyHead description: |- - Checks if a Product Type with given `key` exists. Responds with a `200 OK` status if the `Product Type` exists or `404 Not Found` otherwise. + Checks if a ProductType exists for a given `key`. Returns a `200 OK` status if the ProductType exists or a `404 Not Found` otherwise. responses: "200": description: |- - The ProductType exists + 200 content: {} "404": $ref: '#/components/responses/errorable_404' @@ -20428,11 +24012,11 @@ paths: - "view_products:{projectKey}" operationId: ByProjectKeyProductTypesByIDHead description: |- - Checks if a Product Type with given `id` exists. Responds with a `200 OK` status if the `Product Type` exists or `404 Not Found` otherwise. + Checks if a ProductType exists for a given `id`. Returns a `200 OK` status if the ProductType exists or a `404 Not Found` otherwise. responses: "200": description: |- - The ProductType exists + 200 content: {} "404": $ref: '#/components/responses/errorable_404' @@ -20685,7 +24269,7 @@ paths: - "view_products:{projectKey}" operationId: ByProjectKeyProductsHead description: |- - Check if Products exist. Responds with a `200 OK` status if any Products match the Query Predicate, or `404 Not Found` otherwise. + Checks if a Product exists for a given Query Predicate. Returns a `200 OK` status if any Products match the Query Predicate or a `404 Not Found` otherwise. parameters: - name: where in: query @@ -20699,7 +24283,7 @@ paths: responses: "200": description: |- - At least one Product matching the query exists + 200 content: {} "404": $ref: '#/components/responses/errorable_404' @@ -20895,11 +24479,11 @@ paths: - "view_products:{projectKey}" operationId: ByProjectKeyProductsKeyByKeyHead description: |- - Check if a Product exists with a specified `key`. Responds with a `200 OK` status if the Product exists or `404 Not Found` otherwise. + Checks if a Product exists for a given `key`. Returns a `200 OK` status if the Product exists or a `404 Not Found` otherwise. responses: "200": description: |- - The Product exists + 200 content: {} "404": $ref: '#/components/responses/errorable_404' @@ -21284,11 +24868,11 @@ paths: - "view_products:{projectKey}" operationId: ByProjectKeyProductsByIDHead description: |- - Check if a Product exists with a specified `id`. Responds with a `200 OK` status if the Product exists or `404 Not Found` otherwise. + Checks if a Product exists for a given `id`. Returns a `200 OK` status if the Product exists or a `404 Not Found` otherwise. responses: "200": description: |- - The Product exists + 200 content: {} "404": $ref: '#/components/responses/errorable_404' @@ -21741,6 +25325,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_quote_requests:{projectKey}" + operationId: ByProjectKeyQuoteRequestsHead + description: |- + Checks if a QuoteRequest exists for a given Query Predicate. Returns a `200 OK` status if any QuoteRequests match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -21835,6 +25455,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_quote_requests:{projectKey}" + operationId: ByProjectKeyQuoteRequestsKeyByKeyHead + description: |- + Checks if a QuoteRequest exists for a given `key`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -21986,27 +25632,53 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' - post: + head: security: - oauth_2_0: - - "manage_quote_requests:{projectKey}" - operationId: ByProjectKeyQuoteRequestsByIDPost - 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/QuoteRequestUpdate' - + - "view_quote_requests:{projectKey}" + operationId: ByProjectKeyQuoteRequestsByIDHead + description: |- + Checks if a QuoteRequest exists for a given `id`. Returns a `200 OK` status if the QuoteRequest exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + post: + security: + - oauth_2_0: + - "manage_quote_requests:{projectKey}" + operationId: ByProjectKeyQuoteRequestsByIDPost + 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/QuoteRequestUpdate' + responses: "200": description: |- @@ -22185,6 +25857,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_quotes:{projectKey}" + operationId: ByProjectKeyQuotesHead + description: |- + Checks if a Quote exists for a given Query Predicate. Returns a `200 OK` status if any Quotes match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -22279,6 +25987,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_quotes:{projectKey}" + operationId: ByProjectKeyQuotesKeyByKeyHead + description: |- + Checks if a Quote exists for a given `key`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -22430,6 +26164,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_quotes:{projectKey}" + operationId: ByProjectKeyQuotesByIDHead + description: |- + Checks if a Quote exists for a given `id`. Returns a `200 OK` status if the Quote exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -22629,6 +26389,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyReviewsHead + description: |- + Checks if a Review exists for a given Query Predicate. Returns a `200 OK` status if any Reviews match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -22723,6 +26519,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyReviewsKeyByKeyHead + description: |- + Checks if a Review exists for a given `key`. Returns a `200 OK` status if the Review exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -22874,6 +26696,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + operationId: ByProjectKeyReviewsByIDHead + description: |- + Checks if a Review exists for a given `id`. Returns a `200 OK` status if the Review exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -23075,6 +26923,44 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyShippingMethodsHead + description: |- + Checks if a ShippingMethod exists for a given Query Predicate. Returns a `200 OK` status if any ShippingMethods match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -23172,6 +27058,34 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyShippingMethodsKeyByKeyHead + description: |- + Checks if a ShippingMethod exists for a given `key`. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -23328,6 +27242,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyShippingMethodsMatchingCartHead + description: |- + Checks if a ShippingMethod exists for the given Cart. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise. + parameters: + - name: cartId + in: query + required: true + style: form + schema: + type: "string" + explode: true + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} /{projectKey}/shipping-methods/matching-cart-location: description: |- Get ShippingMethods for a cart and location @@ -23403,6 +27353,56 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyShippingMethodsMatchingCartLocationHead + description: |- + Checks if a ShippingMethod that can ship to the given [Location](ctp:api:type:Location) exists for the given Cart. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise. + parameters: + - name: country + in: query + required: true + style: form + schema: + $ref: '#/components/schemas/CountryCode' + explode: true + - name: state + in: query + required: false + style: form + schema: + type: "string" + explode: true + - name: cartId + in: query + required: true + style: form + schema: + type: "string" + explode: true + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} /{projectKey}/shipping-methods/matching-location: description: |- Get ShippingMethods for a location @@ -23488,6 +27488,56 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyShippingMethodsMatchingLocationHead + description: |- + Checks if a ShippingMethod that can ship to the given [Location](ctp:api:type:Location) exists. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise. + parameters: + - name: country + in: query + required: true + style: form + schema: + $ref: '#/components/schemas/CountryCode' + 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 + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} /{projectKey}/shipping-methods/matching-orderedit: description: |- Get ShippingMethods for an order edit @@ -23552,6 +27602,55 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + operationId: ByProjectKeyShippingMethodsMatchingOrdereditHead + description: |- + Checks if a ShippingMethod that can ship to the given [Location](ctp:api:type:Location) exists for the given [OrderEdit](ctp:api:type:OrderEdit). Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise. + parameters: + - name: orderEditId + in: query + required: true + style: form + schema: + type: "string" + explode: true + - name: country + in: query + required: true + style: form + schema: + $ref: '#/components/schemas/CountryCode' + explode: true + - name: state + in: query + required: false + style: form + schema: + type: "string" + explode: true + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} /{projectKey}/shipping-methods/{ID}: parameters: - name: projectKey @@ -23585,19 +27684,47 @@ paths: "200": description: |- 200 - content: - application/json: - schema: - $ref: '#/components/schemas/ShippingMethod' - + content: + application/json: + schema: + $ref: '#/components/schemas/ShippingMethod' + + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + - "view_shipping_methods:{projectKey}" + - "manage_my_orders:{projectKey}" + operationId: ByProjectKeyShippingMethodsByIDHead + description: |- + Checks if a ShippingMethod exists for a given `id`. Returns a `200 OK` status if the ShippingMethod exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' "400": $ref: '#/components/responses/errorable_400' "401": $ref: '#/components/responses/errorable_401' "403": $ref: '#/components/responses/errorable_403' - "404": - $ref: '#/components/responses/errorable_404' "500": $ref: '#/components/responses/errorable_500' "502": @@ -23798,6 +27925,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + operationId: ByProjectKeyShoppingListsHead + description: |- + Checks if a ShoppingList exists for a given Query Predicate. Returns a `200 OK` status if any ShoppingLists match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -23892,6 +28055,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + operationId: ByProjectKeyShoppingListsKeyByKeyHead + description: |- + Checks if a ShoppingList exists for a given `key`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -24043,6 +28232,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_shopping_lists:{projectKey}" + operationId: ByProjectKeyShoppingListsByIDHead + description: |- + Checks if a ShoppingList exists for a given `id`. Returns a `200 OK` status if the ShoppingList exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -24242,6 +28457,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_staged_quotes:{projectKey}" + operationId: ByProjectKeyStagedQuotesHead + description: |- + Checks if a StagedQuote exists for a given Query Predicate. Returns a `200 OK` status if any StagedQuotes match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -24336,6 +28587,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_staged_quotes:{projectKey}" + operationId: ByProjectKeyStagedQuotesKeyByKeyHead + description: |- + Checks if a StagedQuote exists for a given `key`. Returns a `200 OK` status if the StagedQuote exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -24487,6 +28764,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_staged_quotes:{projectKey}" + operationId: ByProjectKeyStagedQuotesByIDHead + description: |- + Checks if a StagedQuote exists for a given `id`. Returns a `200 OK` status if the StagedQuote exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -24686,6 +28989,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_standalone_prices:{projectKey}" + operationId: ByProjectKeyStandalonePricesHead + description: |- + Checks if a StandalonePrice exists for a given Query Predicate. Returns a `200 OK` status if any StandalonePrices match the Query Predicate, or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -24782,6 +29121,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_standalone_prices:{projectKey}" + operationId: ByProjectKeyStandalonePricesKeyByKeyHead + description: |- + Checks if a StandalonePrice exists for a given `key`. Returns a `200 OK` status if the StandalonePrice exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -24909,19 +29274,45 @@ paths: "200": description: |- 200 - content: - application/json: - schema: - $ref: '#/components/schemas/StandalonePrice' - + content: + application/json: + schema: + $ref: '#/components/schemas/StandalonePrice' + + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_standalone_prices:{projectKey}" + operationId: ByProjectKeyStandalonePricesByIDHead + description: |- + Checks if a StandalonePrice exists for a given `id`. Returns a `200 OK` status if the StandalonePrice exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' "400": $ref: '#/components/responses/errorable_400' "401": $ref: '#/components/responses/errorable_401' "403": $ref: '#/components/responses/errorable_403' - "404": - $ref: '#/components/responses/errorable_404' "500": $ref: '#/components/responses/errorable_500' "502": @@ -25124,6 +29515,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_states:{projectKey}" + operationId: ByProjectKeyStatesHead + description: |- + Checks if a State exists for a given Query Predicate. Returns a `200 OK` status if any States match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -25218,6 +29645,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_states:{projectKey}" + operationId: ByProjectKeyStatesKeyByKeyHead + description: |- + Checks if a State exists for a given `key`. Returns a `200 OK` status if the State exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -25362,6 +29815,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_states:{projectKey}" + operationId: ByProjectKeyStatesByIDHead + description: |- + Checks if a State exists for a given `id`. Returns a `200 OK` status if the State exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -25554,6 +30033,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_stores:{projectKey}" + operationId: ByProjectKeyStoresHead + description: |- + Checks if a Store exists for a given Query Predicate. Returns a `200 OK` status if any Stores match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -25648,6 +30163,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_stores:{projectKey}" + operationId: ByProjectKeyStoresKeyByKeyHead + description: |- + Checks if a Store exists for a given `key`. Returns a `200 OK` status if the Store exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -25792,6 +30333,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_states:{projectKey}" + operationId: ByProjectKeyStoresByIDHead + description: |- + Checks if a Store exists for a given `id`. Returns a `200 OK` status if the Store exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -25975,6 +30542,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_subscriptions:{projectKey}" + operationId: ByProjectKeySubscriptionsHead + description: |- + Checks if a Subscription exists for a given Query Predicate. Returns a `200 OK` status if any Subscriptions match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} post: security: - oauth_2_0: @@ -26051,6 +30654,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_subscriptions:{projectKey}" + operationId: ByProjectKeySubscriptionsKeyByKeyHead + description: |- + Checks if a Subscription exists for a given `key`. Returns a `200 OK` status if the Subscription exists or a `404 Not Found` otherwise. + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} post: security: - oauth_2_0: @@ -26166,6 +30795,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "manage_subscriptions:{projectKey}" + operationId: ByProjectKeySubscriptionsByIDHead + description: |- + Checks if a Subscription exists for a given `id`. Returns a `200 OK` status if the Subscription exists or a `404 Not Found` otherwise. + responses: + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "404": + $ref: '#/components/responses/errorable_404' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' + "200": + description: |- + 200 + content: {} post: security: - oauth_2_0: @@ -26369,6 +31024,43 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_tax_categories:{projectKey}" + operationId: ByProjectKeyTaxCategoriesHead + description: |- + Checks if a TaxCategory exists for a given Query Predicate. Returns a `200 OK` status if any TaxCategories match the Query Predicate, or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -26465,6 +31157,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_tax_categories:{projectKey}" + operationId: ByProjectKeyTaxCategoriesKeyByKeyHead + description: |- + Checks if a TaxCategory exists for a given `key`. Returns a `200 OK` status if the Tax Category exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -26612,6 +31331,33 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_products:{projectKey}" + - "view_tax_categories:{projectKey}" + operationId: ByProjectKeyTaxCategoriesByIDHead + description: |- + Checks if a TaxCategory exists for a given `id`. Returns a `200 OK` status if the TaxCategory exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -26806,6 +31552,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_types:{projectKey}" + operationId: ByProjectKeyTypesHead + description: |- + Checks if a Type exists for a given Query Predicate. Returns a `200 OK` status if any Types match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -26900,6 +31682,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_types:{projectKey}" + operationId: ByProjectKeyTypesKeyByKeyHead + description: |- + Checks if a Type exists for a given `key`. Returns a `200 OK` status if the Type exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -27044,6 +31852,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_types:{projectKey}" + operationId: ByProjectKeyTypesByIDHead + description: |- + Checks if a Type exists for a given `id`. Returns a `200 OK` status if the Type exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -27236,6 +32070,42 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyZonesHead + description: |- + Checks if a Zone exists for a given Query Predicate. Returns a `200 OK` status if any Zones match the Query Predicate or a `404 Not Found` otherwise. + parameters: + - name: where + in: query + required: false + style: form + schema: + type: "array" + items: + $ref: '#/components/schemas/QueryPredicate' + explode: true + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -27330,6 +32200,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyZonesKeyByKeyHead + description: |- + Checks if a Zone exists for a given `key`. Returns a `200 OK` status if the Zone exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: @@ -27474,6 +32370,32 @@ paths: $ref: '#/components/responses/errorable_502' "503": $ref: '#/components/responses/errorable_503' + head: + security: + - oauth_2_0: + - "view_orders:{projectKey}" + operationId: ByProjectKeyZonesByIDHead + description: |- + Checks if a Zone exists for a given `id`. Returns a `200 OK` status if the Zone exists or a `404 Not Found` otherwise. + responses: + "200": + description: |- + 200 + content: {} + "404": + $ref: '#/components/responses/errorable_404' + "400": + $ref: '#/components/responses/errorable_400' + "401": + $ref: '#/components/responses/errorable_401' + "403": + $ref: '#/components/responses/errorable_403' + "500": + $ref: '#/components/responses/errorable_500' + "502": + $ref: '#/components/responses/errorable_502' + "503": + $ref: '#/components/responses/errorable_503' post: security: - oauth_2_0: diff --git a/oas/history/openapi.yaml b/oas/history/openapi.yaml index e9856463c..8f52cdb41 100644 --- a/oas/history/openapi.yaml +++ b/oas/history/openapi.yaml @@ -7287,9 +7287,9 @@ components: change: type: "string" previousValue: - $ref: '#/components/schemas/LocalizedString' + type: "string" nextValue: - $ref: '#/components/schemas/LocalizedString' + type: "string" SetLocalizedNameChange: allOf: - $ref: '#/components/schemas/Change' diff --git a/uml/api/_index.puml b/uml/api/_index.puml index cfe45526f..04b10219c 100644 --- a/uml/api/_index.puml +++ b/uml/api/_index.puml @@ -6,6 +6,10 @@ responses: [[Project.svg Project]] ; +***: HEAD + responses: + +; ***: POST request: [[ProjectUpdate.svg ProjectUpdate]] responses: @@ -16,6 +20,10 @@ responses: [[ApiClientPagedQueryResponse.svg ApiClientPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[ApiClientDraft.svg ApiClientDraft]] responses: @@ -26,6 +34,10 @@ responses: [[ApiClient.svg ApiClient]] ; +*****: HEAD + responses: + +; *****: DELETE responses: [[ApiClient.svg ApiClient]] @@ -40,6 +52,10 @@ responses: [[BusinessUnitPagedQueryResponse.svg BusinessUnitPagedQueryResponse]] ; +******: HEAD + responses: + +; ******: POST request: [[BusinessUnitDraft.svg BusinessUnitDraft]] responses: @@ -50,6 +66,10 @@ responses: [[BusinessUnit.svg BusinessUnit]] ; +*******: HEAD + responses: + +; *******: POST request: [[BusinessUnitUpdate.svg BusinessUnitUpdate]] responses: @@ -61,6 +81,10 @@ responses: [[BusinessUnit.svg BusinessUnit]] ; +*******: HEAD + responses: + +; *******: POST request: [[BusinessUnitUpdate.svg BusinessUnitUpdate]] responses: @@ -122,6 +146,10 @@ responses: [[CartPagedQueryResponse.svg CartPagedQueryResponse]] ; +*******: HEAD + responses: + +; *******: POST request: [[CartDraft.svg CartDraft]] responses: @@ -132,6 +160,10 @@ responses: [[Cart.svg Cart]] ; +********: HEAD + responses: + +; ********: POST request: [[CartUpdate.svg CartUpdate]] responses: @@ -154,6 +186,10 @@ responses: [[Cart.svg Cart]] ; +********: HEAD + responses: + +; ********: POST request: [[CartUpdate.svg CartUpdate]] responses: @@ -169,6 +205,10 @@ responses: [[OrderPagedQueryResponse.svg OrderPagedQueryResponse]] ; +*******: HEAD + responses: + +; *******: POST request: [[OrderFromCartDraft.svg OrderFromCartDraft]] responses: @@ -179,6 +219,10 @@ responses: [[Order.svg Order]] ; +********: HEAD + responses: + +; ********: POST request: [[OrderUpdate.svg OrderUpdate]] responses: @@ -197,6 +241,10 @@ responses: [[Order.svg Order]] ; +********: HEAD + responses: + +; ********: POST request: [[OrderUpdate.svg OrderUpdate]] responses: @@ -208,6 +256,10 @@ responses: [[QuoteRequestPagedQueryResponse.svg QuoteRequestPagedQueryResponse]] ; +*******: HEAD + responses: + +; *******: POST request: [[QuoteRequestDraft.svg QuoteRequestDraft]] responses: @@ -218,6 +270,10 @@ responses: [[QuoteRequest.svg QuoteRequest]] ; +********: HEAD + responses: + +; ********: POST request: [[QuoteRequestUpdate.svg QuoteRequestUpdate]] responses: @@ -229,6 +285,10 @@ responses: [[QuoteRequest.svg QuoteRequest]] ; +********: HEAD + responses: + +; ********: POST request: [[QuoteRequestUpdate.svg QuoteRequestUpdate]] responses: @@ -240,11 +300,19 @@ responses: [[QuotePagedQueryResponse.svg QuotePagedQueryResponse]] ; +*******: HEAD + responses: + +; ******* /key={key} ********: GET responses: [[Quote.svg Quote]] ; +********: HEAD + responses: + +; ********: POST request: [[QuoteUpdate.svg QuoteUpdate]] responses: @@ -256,6 +324,10 @@ responses: [[Quote.svg Quote]] ; +********: HEAD + responses: + +; ********: POST request: [[QuoteUpdate.svg QuoteUpdate]] responses: @@ -267,6 +339,10 @@ responses: [[AssociateRolePagedQueryResponse.svg AssociateRolePagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[AssociateRoleDraft.svg AssociateRoleDraft]] responses: @@ -277,6 +353,10 @@ responses: [[AssociateRole.svg AssociateRole]] ; +*****: HEAD + responses: + +; *****: POST request: [[AssociateRoleUpdate.svg AssociateRoleUpdate]] responses: @@ -292,6 +372,10 @@ responses: [[AssociateRole.svg AssociateRole]] ; +*****: HEAD + responses: + +; *****: POST request: [[AssociateRoleUpdate.svg AssociateRoleUpdate]] responses: @@ -307,6 +391,10 @@ responses: [[AttributeGroupPagedQueryResponse.svg AttributeGroupPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[AttributeGroupDraft.svg AttributeGroupDraft]] responses: @@ -317,6 +405,10 @@ responses: [[AttributeGroup.svg AttributeGroup]] ; +*****: HEAD + responses: + +; *****: POST request: [[AttributeGroupUpdate.svg AttributeGroupUpdate]] responses: @@ -332,6 +424,10 @@ responses: [[AttributeGroup.svg AttributeGroup]] ; +*****: HEAD + responses: + +; *****: POST request: [[AttributeGroupUpdate.svg AttributeGroupUpdate]] responses: @@ -347,6 +443,10 @@ responses: [[BusinessUnitPagedQueryResponse.svg BusinessUnitPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[BusinessUnitDraft.svg BusinessUnitDraft]] responses: @@ -357,6 +457,10 @@ responses: [[BusinessUnit.svg BusinessUnit]] ; +*****: HEAD + responses: + +; *****: POST request: [[BusinessUnitUpdate.svg BusinessUnitUpdate]] responses: @@ -372,6 +476,10 @@ responses: [[BusinessUnit.svg BusinessUnit]] ; +*****: HEAD + responses: + +; *****: POST request: [[BusinessUnitUpdate.svg BusinessUnitUpdate]] responses: @@ -387,6 +495,10 @@ responses: [[CartDiscountPagedQueryResponse.svg CartDiscountPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[CartDiscountDraft.svg CartDiscountDraft]] responses: @@ -397,6 +509,10 @@ responses: [[CartDiscount.svg CartDiscount]] ; +*****: HEAD + responses: + +; *****: POST request: [[CartDiscountUpdate.svg CartDiscountUpdate]] responses: @@ -412,6 +528,10 @@ responses: [[CartDiscount.svg CartDiscount]] ; +*****: HEAD + responses: + +; *****: POST request: [[CartDiscountUpdate.svg CartDiscountUpdate]] responses: @@ -427,6 +547,10 @@ responses: [[CartPagedQueryResponse.svg CartPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[CartDraft.svg CartDraft]] responses: @@ -437,12 +561,20 @@ responses: [[Cart.svg Cart]] ; +*****: HEAD + responses: + +; **** /key={key} *****: GET responses: [[Cart.svg Cart]] ; +*****: HEAD + responses: + +; *****: POST request: [[CartUpdate.svg CartUpdate]] responses: @@ -465,6 +597,10 @@ responses: [[Cart.svg Cart]] ; +*****: HEAD + responses: + +; *****: POST request: [[CartUpdate.svg CartUpdate]] responses: @@ -480,6 +616,10 @@ responses: [[CategoryPagedQueryResponse.svg CategoryPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[CategoryDraft.svg CategoryDraft]] responses: @@ -490,6 +630,10 @@ responses: [[Category.svg Category]] ; +*****: HEAD + responses: + +; *****: POST request: [[CategoryUpdate.svg CategoryUpdate]] responses: @@ -505,6 +649,10 @@ responses: [[Category.svg Category]] ; +*****: HEAD + responses: + +; *****: POST request: [[CategoryUpdate.svg CategoryUpdate]] responses: @@ -520,6 +668,10 @@ responses: [[ChannelPagedQueryResponse.svg ChannelPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[ChannelDraft.svg ChannelDraft]] responses: @@ -530,6 +682,10 @@ responses: [[Channel.svg Channel]] ; +*****: HEAD + responses: + +; *****: POST request: [[ChannelUpdate.svg ChannelUpdate]] responses: @@ -545,6 +701,10 @@ responses: [[CustomObjectPagedQueryResponse.svg CustomObjectPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[CustomObjectDraft.svg CustomObjectDraft]] responses: @@ -571,6 +731,10 @@ responses: [[CustomerGroupPagedQueryResponse.svg CustomerGroupPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[CustomerGroupDraft.svg CustomerGroupDraft]] responses: @@ -581,6 +745,10 @@ responses: [[CustomerGroup.svg CustomerGroup]] ; +*****: HEAD + responses: + +; *****: POST request: [[CustomerGroupUpdate.svg CustomerGroupUpdate]] responses: @@ -596,6 +764,10 @@ responses: [[CustomerGroup.svg CustomerGroup]] ; +*****: HEAD + responses: + +; *****: POST request: [[CustomerGroupUpdate.svg CustomerGroupUpdate]] responses: @@ -611,6 +783,10 @@ responses: [[CustomerPagedQueryResponse.svg CustomerPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[CustomerDraft.svg CustomerDraft]] responses: @@ -641,6 +817,10 @@ responses: [[Customer.svg Customer]] ; +*****: HEAD + responses: + +; *****: POST request: [[CustomerUpdate.svg CustomerUpdate]] responses: @@ -683,6 +863,10 @@ responses: [[Customer.svg Customer]] ; +*****: HEAD + responses: + +; *****: POST request: [[CustomerUpdate.svg CustomerUpdate]] responses: @@ -698,6 +882,10 @@ responses: [[DiscountCodePagedQueryResponse.svg DiscountCodePagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[DiscountCodeDraft.svg DiscountCodeDraft]] responses: @@ -708,6 +896,10 @@ responses: [[DiscountCode.svg DiscountCode]] ; +*****: HEAD + responses: + +; *****: POST request: [[DiscountCodeUpdate.svg DiscountCodeUpdate]] responses: @@ -723,6 +915,10 @@ responses: [[ExtensionPagedQueryResponse.svg ExtensionPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[ExtensionDraft.svg ExtensionDraft]] responses: @@ -733,6 +929,10 @@ responses: [[Extension.svg Extension]] ; +*****: HEAD + responses: + +; *****: POST request: [[ExtensionUpdate.svg ExtensionUpdate]] responses: @@ -748,6 +948,10 @@ responses: [[Extension.svg Extension]] ; +*****: HEAD + responses: + +; *****: POST request: [[ExtensionUpdate.svg ExtensionUpdate]] responses: @@ -783,6 +987,10 @@ responses: [[CartDiscount.svg CartDiscount]] ; +*****: HEAD + responses: + +; *****: POST request: [[CartDiscountDraft.svg CartDiscountDraft]] responses: @@ -793,6 +1001,10 @@ responses: [[CartDiscount.svg CartDiscount]] ; +******: HEAD + responses: + +; ******: POST request: [[CartDiscountUpdate.svg CartDiscountUpdate]] responses: @@ -808,6 +1020,10 @@ responses: [[CartDiscount.svg CartDiscount]] ; +******: HEAD + responses: + +; ******: POST request: [[CartDiscountUpdate.svg CartDiscountUpdate]] responses: @@ -823,6 +1039,10 @@ responses: [[CartPagedQueryResponse.svg CartPagedQueryResponse]] ; +*****: HEAD + responses: + +; *****: POST request: [[CartDraft.svg CartDraft]] responses: @@ -833,12 +1053,20 @@ responses: [[Cart.svg Cart]] ; +******: HEAD + responses: + +; ***** /key={key} ******: GET responses: [[Cart.svg Cart]] ; +******: HEAD + responses: + +; ******: POST request: [[CartUpdate.svg CartUpdate]] responses: @@ -861,6 +1089,10 @@ responses: [[Cart.svg Cart]] ; +******: HEAD + responses: + +; ******: POST request: [[CartUpdate.svg CartUpdate]] responses: @@ -876,6 +1108,10 @@ responses: [[CustomerPagedQueryResponse.svg CustomerPagedQueryResponse]] ; +*****: HEAD + responses: + +; *****: POST request: [[CustomerDraft.svg CustomerDraft]] responses: @@ -906,6 +1142,10 @@ responses: [[Customer.svg Customer]] ; +******: HEAD + responses: + +; ******: POST request: [[CustomerUpdate.svg CustomerUpdate]] responses: @@ -948,6 +1188,10 @@ responses: [[Customer.svg Customer]] ; +******: HEAD + responses: + +; ******: POST request: [[CustomerUpdate.svg CustomerUpdate]] responses: @@ -984,12 +1228,20 @@ responses: [[Cart.svg Cart]] ; +******: HEAD + responses: + +; ***** /carts ******: GET responses: [[CartPagedQueryResponse.svg CartPagedQueryResponse]] ; +******: HEAD + responses: + +; ******: POST request: [[MyCartDraft.svg MyCartDraft]] responses: @@ -1000,6 +1252,10 @@ responses: [[Cart.svg Cart]] ; +*******: HEAD + responses: + +; *******: POST request: [[MyCartUpdate.svg MyCartUpdate]] responses: @@ -1029,6 +1285,10 @@ responses: [[OrderPagedQueryResponse.svg OrderPagedQueryResponse]] ; +******: HEAD + responses: + +; ******: POST request: [[MyOrderFromCartDraft.svg MyOrderFromCartDraft]] responses: @@ -1039,6 +1299,10 @@ responses: [[Order.svg Order]] ; +*******: HEAD + responses: + +; ***** /password ******: POST @@ -1058,6 +1322,10 @@ responses: [[ShoppingListPagedQueryResponse.svg ShoppingListPagedQueryResponse]] ; +******: HEAD + responses: + +; ******: POST request: [[MyShoppingListDraft.svg MyShoppingListDraft]] responses: @@ -1068,6 +1336,10 @@ responses: [[ShoppingList.svg ShoppingList]] ; +*******: HEAD + responses: + +; *******: POST request: [[MyShoppingListUpdate.svg MyShoppingListUpdate]] responses: @@ -1083,6 +1355,10 @@ responses: [[ShoppingList.svg ShoppingList]] ; +*******: HEAD + responses: + +; *******: POST request: [[MyShoppingListUpdate.svg MyShoppingListUpdate]] responses: @@ -1105,6 +1381,10 @@ responses: [[OrderPagedQueryResponse.svg OrderPagedQueryResponse]] ; +*****: HEAD + responses: + +; *****: POST request: [[OrderFromCartDraft.svg OrderFromCartDraft]] responses: @@ -1115,6 +1395,10 @@ responses: [[Order.svg Order]] ; +******: HEAD + responses: + +; ******: POST request: [[OrderUpdate.svg OrderUpdate]] responses: @@ -1130,6 +1414,10 @@ responses: [[Order.svg Order]] ; +******: HEAD + responses: + +; ******: POST request: [[OrderUpdate.svg OrderUpdate]] responses: @@ -1147,12 +1435,20 @@ responses: [[ProductProjection.svg ProductProjection]] ; - +******: HEAD + responses: + +; + ***** /{ID} ******: GET responses: [[ProductProjection.svg ProductProjection]] ; +******: HEAD + responses: + +; **** /product-selection-assignments *****: GET @@ -1167,12 +1463,20 @@ responses: [[ShippingMethodPagedQueryResponse.svg ShippingMethodPagedQueryResponse]] ; +******: HEAD + responses: + +; **** /shopping-lists *****: GET responses: [[ShoppingListPagedQueryResponse.svg ShoppingListPagedQueryResponse]] ; +*****: HEAD + responses: + +; *****: POST request: [[ShoppingListDraft.svg ShoppingListDraft]] responses: @@ -1183,6 +1487,10 @@ responses: [[ShoppingList.svg ShoppingList]] ; +******: HEAD + responses: + +; ******: POST request: [[ShoppingListUpdate.svg ShoppingListUpdate]] responses: @@ -1198,6 +1506,10 @@ responses: [[ShoppingList.svg ShoppingList]] ; +******: HEAD + responses: + +; ******: POST request: [[ShoppingListUpdate.svg ShoppingListUpdate]] responses: @@ -1213,6 +1525,10 @@ responses: [[InventoryPagedQueryResponse.svg InventoryPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[InventoryEntryDraft.svg InventoryEntryDraft]] responses: @@ -1223,6 +1539,10 @@ responses: [[InventoryEntry.svg InventoryEntry]] ; +*****: HEAD + responses: + +; *****: POST request: [[InventoryEntryUpdate.svg InventoryEntryUpdate]] responses: @@ -1238,6 +1558,10 @@ responses: [[InventoryEntry.svg InventoryEntry]] ; +*****: HEAD + responses: + +; *****: POST request: [[InventoryEntryUpdate.svg InventoryEntryUpdate]] responses: @@ -1274,12 +1598,20 @@ responses: [[Cart.svg Cart]] ; +*****: HEAD + responses: + +; **** /business-units *****: GET responses: [[BusinessUnitPagedQueryResponse.svg BusinessUnitPagedQueryResponse]] ; +*****: HEAD + responses: + +; *****: POST request: [[MyBusinessUnitDraft.svg MyBusinessUnitDraft]] responses: @@ -1290,6 +1622,10 @@ responses: [[BusinessUnit.svg BusinessUnit]] ; +******: HEAD + responses: + +; ******: POST request: [[MyBusinessUnitUpdate.svg MyBusinessUnitUpdate]] responses: @@ -1305,6 +1641,10 @@ responses: [[BusinessUnit.svg BusinessUnit]] ; +******: HEAD + responses: + +; ******: POST request: [[MyBusinessUnitUpdate.svg MyBusinessUnitUpdate]] responses: @@ -1320,6 +1660,10 @@ responses: [[CartPagedQueryResponse.svg CartPagedQueryResponse]] ; +*****: HEAD + responses: + +; *****: POST request: [[MyCartDraft.svg MyCartDraft]] responses: @@ -1330,6 +1674,10 @@ responses: [[Cart.svg Cart]] ; +******: HEAD + responses: + +; ******: POST request: [[MyCartUpdate.svg MyCartUpdate]] responses: @@ -1352,6 +1700,10 @@ responses: [[Cart.svg Cart]] ; +******: HEAD + responses: + +; ******: POST request: [[MyCartUpdate.svg MyCartUpdate]] responses: @@ -1381,6 +1733,10 @@ responses: [[OrderPagedQueryResponse.svg OrderPagedQueryResponse]] ; +*****: HEAD + responses: + +; *****: POST request: [[MyOrderFromCartDraft.svg MyOrderFromCartDraft]] responses: @@ -1398,6 +1754,10 @@ responses: [[Order.svg Order]] ; +******: HEAD + responses: + +; **** /password *****: POST @@ -1417,6 +1777,10 @@ responses: [[MyPaymentPagedQueryResponse.svg MyPaymentPagedQueryResponse]] ; +*****: HEAD + responses: + +; *****: POST request: [[MyPaymentDraft.svg MyPaymentDraft]] responses: @@ -1427,6 +1791,10 @@ responses: [[MyPayment.svg MyPayment]] ; +******: HEAD + responses: + +; ******: POST request: [[MyPaymentUpdate.svg MyPaymentUpdate]] responses: @@ -1442,6 +1810,10 @@ responses: [[QuoteRequestPagedQueryResponse.svg QuoteRequestPagedQueryResponse]] ; +*****: HEAD + responses: + +; *****: POST request: [[MyQuoteRequestDraft.svg MyQuoteRequestDraft]] responses: @@ -1452,6 +1824,10 @@ responses: [[QuoteRequest.svg QuoteRequest]] ; +******: HEAD + responses: + +; ******: POST request: [[MyQuoteRequestUpdate.svg MyQuoteRequestUpdate]] responses: @@ -1467,6 +1843,10 @@ responses: [[QuoteRequest.svg QuoteRequest]] ; +******: HEAD + responses: + +; ******: POST request: [[MyQuoteRequestUpdate.svg MyQuoteRequestUpdate]] responses: @@ -1482,11 +1862,19 @@ responses: [[QuotePagedQueryResponse.svg QuotePagedQueryResponse]] ; +*****: HEAD + responses: + +; ***** /key={key} ******: GET responses: [[Quote.svg Quote]] ; +******: HEAD + responses: + +; ******: POST request: [[MyQuoteUpdate.svg MyQuoteUpdate]] responses: @@ -1498,6 +1886,10 @@ responses: [[Quote.svg Quote]] ; +******: HEAD + responses: + +; ******: POST request: [[MyQuoteUpdate.svg MyQuoteUpdate]] responses: @@ -1509,6 +1901,10 @@ responses: [[ShoppingListPagedQueryResponse.svg ShoppingListPagedQueryResponse]] ; +*****: HEAD + responses: + +; *****: POST request: [[MyShoppingListDraft.svg MyShoppingListDraft]] responses: @@ -1519,6 +1915,10 @@ responses: [[ShoppingList.svg ShoppingList]] ; +******: HEAD + responses: + +; ******: POST request: [[MyShoppingListUpdate.svg MyShoppingListUpdate]] responses: @@ -1534,6 +1934,10 @@ responses: [[ShoppingList.svg ShoppingList]] ; +******: HEAD + responses: + +; ******: POST request: [[MyShoppingListUpdate.svg MyShoppingListUpdate]] responses: @@ -1556,17 +1960,29 @@ responses: [[MessagePagedQueryResponse.svg MessagePagedQueryResponse]] ; +****: HEAD + responses: + +; **** /{ID} *****: GET responses: [[Message.svg Message]] ; +*****: HEAD + responses: + +; *** /orders ****: GET responses: [[OrderPagedQueryResponse.svg OrderPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[OrderFromCartDraft.svg OrderFromCartDraft]] responses: @@ -1577,6 +1993,10 @@ responses: [[OrderEditPagedQueryResponse.svg OrderEditPagedQueryResponse]] ; +*****: HEAD + responses: + +; *****: POST request: [[OrderEditDraft.svg OrderEditDraft]] responses: @@ -1587,6 +2007,10 @@ responses: [[OrderEdit.svg OrderEdit]] ; +******: HEAD + responses: + +; ******: POST request: [[OrderEditUpdate.svg OrderEditUpdate]] responses: @@ -1602,6 +2026,10 @@ responses: [[OrderEdit.svg OrderEdit]] ; +******: HEAD + responses: + +; ******: POST request: [[OrderEditUpdate.svg OrderEditUpdate]] responses: @@ -1630,6 +2058,10 @@ responses: [[Order.svg Order]] ; +*****: HEAD + responses: + +; *****: POST request: [[OrderUpdate.svg OrderUpdate]] responses: @@ -1663,6 +2095,10 @@ responses: [[Order.svg Order]] ; +*****: HEAD + responses: + +; *****: POST request: [[OrderUpdate.svg OrderUpdate]] responses: @@ -1678,6 +2114,10 @@ responses: [[PaymentPagedQueryResponse.svg PaymentPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[PaymentDraft.svg PaymentDraft]] responses: @@ -1688,6 +2128,10 @@ responses: [[Payment.svg Payment]] ; +*****: HEAD + responses: + +; *****: POST request: [[PaymentUpdate.svg PaymentUpdate]] responses: @@ -1703,6 +2147,10 @@ responses: [[Payment.svg Payment]] ; +*****: HEAD + responses: + +; *****: POST request: [[PaymentUpdate.svg PaymentUpdate]] responses: @@ -1718,6 +2166,10 @@ responses: [[ProductDiscountPagedQueryResponse.svg ProductDiscountPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[ProductDiscountDraft.svg ProductDiscountDraft]] responses: @@ -1728,6 +2180,10 @@ responses: [[ProductDiscount.svg ProductDiscount]] ; +*****: HEAD + responses: + +; *****: POST request: [[ProductDiscountUpdate.svg ProductDiscountUpdate]] responses: @@ -1750,6 +2206,10 @@ responses: [[ProductDiscount.svg ProductDiscount]] ; +*****: HEAD + responses: + +; *****: POST request: [[ProductDiscountUpdate.svg ProductDiscountUpdate]] responses: @@ -1765,11 +2225,19 @@ responses: [[ProductProjectionPagedQueryResponse.svg ProductProjectionPagedQueryResponse]] ; +****: HEAD + responses: + +; **** /key={key} *****: GET responses: [[ProductProjection.svg ProductProjection]] ; +*****: HEAD + responses: + +; **** /search *****: POST @@ -1793,12 +2261,20 @@ responses: [[ProductProjection.svg ProductProjection]] ; +*****: HEAD + responses: + +; *** /product-selections ****: GET responses: [[ProductSelectionPagedQueryResponse.svg ProductSelectionPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[ProductSelectionDraft.svg ProductSelectionDraft]] responses: @@ -1809,6 +2285,10 @@ responses: [[ProductSelection.svg ProductSelection]] ; +*****: HEAD + responses: + +; *****: POST request: [[ProductSelectionUpdate.svg ProductSelectionUpdate]] responses: @@ -1829,6 +2309,10 @@ responses: [[ProductSelection.svg ProductSelection]] ; +*****: HEAD + responses: + +; *****: POST request: [[ProductSelectionUpdate.svg ProductSelectionUpdate]] responses: @@ -1970,6 +2454,10 @@ responses: [[QuoteRequestPagedQueryResponse.svg QuoteRequestPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[QuoteRequestDraft.svg QuoteRequestDraft]] responses: @@ -1980,6 +2468,10 @@ responses: [[QuoteRequest.svg QuoteRequest]] ; +*****: HEAD + responses: + +; *****: POST request: [[QuoteRequestUpdate.svg QuoteRequestUpdate]] responses: @@ -1995,6 +2487,10 @@ responses: [[QuoteRequest.svg QuoteRequest]] ; +*****: HEAD + responses: + +; *****: POST request: [[QuoteRequestUpdate.svg QuoteRequestUpdate]] responses: @@ -2010,6 +2506,10 @@ responses: [[QuotePagedQueryResponse.svg QuotePagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[QuoteDraft.svg QuoteDraft]] responses: @@ -2020,6 +2520,10 @@ responses: [[Quote.svg Quote]] ; +*****: HEAD + responses: + +; *****: POST request: [[QuoteUpdate.svg QuoteUpdate]] responses: @@ -2035,6 +2539,10 @@ responses: [[Quote.svg Quote]] ; +*****: HEAD + responses: + +; *****: POST request: [[QuoteUpdate.svg QuoteUpdate]] responses: @@ -2050,6 +2558,10 @@ responses: [[ReviewPagedQueryResponse.svg ReviewPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[ReviewDraft.svg ReviewDraft]] responses: @@ -2060,6 +2572,10 @@ responses: [[Review.svg Review]] ; +*****: HEAD + responses: + +; *****: POST request: [[ReviewUpdate.svg ReviewUpdate]] responses: @@ -2075,6 +2591,10 @@ responses: [[Review.svg Review]] ; +*****: HEAD + responses: + +; *****: POST request: [[ReviewUpdate.svg ReviewUpdate]] responses: @@ -2090,6 +2610,10 @@ responses: [[ShippingMethodPagedQueryResponse.svg ShippingMethodPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[ShippingMethodDraft.svg ShippingMethodDraft]] responses: @@ -2100,6 +2624,10 @@ responses: [[ShippingMethod.svg ShippingMethod]] ; +*****: HEAD + responses: + +; *****: POST request: [[ShippingMethodUpdate.svg ShippingMethodUpdate]] responses: @@ -2115,30 +2643,50 @@ responses: [[ShippingMethodPagedQueryResponse.svg ShippingMethodPagedQueryResponse]] ; +*****: HEAD + responses: + +; **** /matching-cart-location *****: GET responses: [[ShippingMethodPagedQueryResponse.svg ShippingMethodPagedQueryResponse]] ; +*****: HEAD + responses: + +; **** /matching-location *****: GET responses: [[ShippingMethodPagedQueryResponse.svg ShippingMethodPagedQueryResponse]] ; +*****: HEAD + responses: + +; **** /matching-orderedit *****: GET responses: [[ShippingMethodPagedQueryResponse.svg ShippingMethodPagedQueryResponse]] ; +*****: HEAD + responses: + +; **** /{ID} *****: GET responses: [[ShippingMethod.svg ShippingMethod]] ; +*****: HEAD + responses: + +; *****: POST request: [[ShippingMethodUpdate.svg ShippingMethodUpdate]] responses: @@ -2154,6 +2702,10 @@ responses: [[ShoppingListPagedQueryResponse.svg ShoppingListPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[ShoppingListDraft.svg ShoppingListDraft]] responses: @@ -2164,6 +2716,10 @@ responses: [[ShoppingList.svg ShoppingList]] ; +*****: HEAD + responses: + +; *****: POST request: [[ShoppingListUpdate.svg ShoppingListUpdate]] responses: @@ -2179,6 +2735,10 @@ responses: [[ShoppingList.svg ShoppingList]] ; +*****: HEAD + responses: + +; *****: POST request: [[ShoppingListUpdate.svg ShoppingListUpdate]] responses: @@ -2194,6 +2754,10 @@ responses: [[StagedQuotePagedQueryResponse.svg StagedQuotePagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[StagedQuoteDraft.svg StagedQuoteDraft]] responses: @@ -2204,6 +2768,10 @@ responses: [[StagedQuote.svg StagedQuote]] ; +*****: HEAD + responses: + +; *****: POST request: [[StagedQuoteUpdate.svg StagedQuoteUpdate]] responses: @@ -2219,6 +2787,10 @@ responses: [[StagedQuote.svg StagedQuote]] ; +*****: HEAD + responses: + +; *****: POST request: [[StagedQuoteUpdate.svg StagedQuoteUpdate]] responses: @@ -2234,6 +2806,10 @@ responses: [[StandalonePricePagedQueryResponse.svg StandalonePricePagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[StandalonePriceDraft.svg StandalonePriceDraft]] responses: @@ -2244,6 +2820,10 @@ responses: [[StandalonePrice.svg StandalonePrice]] ; +*****: HEAD + responses: + +; *****: POST request: [[StandalonePriceUpdate.svg StandalonePriceUpdate]] responses: @@ -2259,6 +2839,10 @@ responses: [[StandalonePrice.svg StandalonePrice]] ; +*****: HEAD + responses: + +; *****: POST request: [[StandalonePriceUpdate.svg StandalonePriceUpdate]] responses: @@ -2274,6 +2858,10 @@ responses: [[StatePagedQueryResponse.svg StatePagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[StateDraft.svg StateDraft]] responses: @@ -2284,6 +2872,10 @@ responses: [[State.svg State]] ; +*****: HEAD + responses: + +; *****: POST request: [[StateUpdate.svg StateUpdate]] responses: @@ -2299,6 +2891,10 @@ responses: [[State.svg State]] ; +*****: HEAD + responses: + +; *****: POST request: [[StateUpdate.svg StateUpdate]] responses: @@ -2314,6 +2910,10 @@ responses: [[StorePagedQueryResponse.svg StorePagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[StoreDraft.svg StoreDraft]] responses: @@ -2324,6 +2924,10 @@ responses: [[Store.svg Store]] ; +*****: HEAD + responses: + +; *****: POST request: [[StoreUpdate.svg StoreUpdate]] responses: @@ -2339,6 +2943,10 @@ responses: [[Store.svg Store]] ; +*****: HEAD + responses: + +; *****: POST request: [[StoreUpdate.svg StoreUpdate]] responses: @@ -2354,6 +2962,10 @@ responses: [[SubscriptionPagedQueryResponse.svg SubscriptionPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[SubscriptionDraft.svg SubscriptionDraft]] responses: @@ -2364,6 +2976,10 @@ responses: [[Subscription.svg Subscription]] ; +*****: HEAD + responses: + +; *****: POST request: [[SubscriptionUpdate.svg SubscriptionUpdate]] responses: @@ -2379,6 +2995,10 @@ responses: [[Subscription.svg Subscription]] ; +*****: HEAD + responses: + +; *****: POST request: [[SubscriptionUpdate.svg SubscriptionUpdate]] responses: @@ -2399,6 +3019,10 @@ responses: [[TaxCategoryPagedQueryResponse.svg TaxCategoryPagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[TaxCategoryDraft.svg TaxCategoryDraft]] responses: @@ -2409,6 +3033,10 @@ responses: [[TaxCategory.svg TaxCategory]] ; +*****: HEAD + responses: + +; *****: POST request: [[TaxCategoryUpdate.svg TaxCategoryUpdate]] responses: @@ -2424,6 +3052,10 @@ responses: [[TaxCategory.svg TaxCategory]] ; +*****: HEAD + responses: + +; *****: POST request: [[TaxCategoryUpdate.svg TaxCategoryUpdate]] responses: @@ -2439,6 +3071,10 @@ responses: [[TypePagedQueryResponse.svg TypePagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[TypeDraft.svg TypeDraft]] responses: @@ -2449,6 +3085,10 @@ responses: [[Type.svg Type]] ; +*****: HEAD + responses: + +; *****: POST request: [[TypeUpdate.svg TypeUpdate]] responses: @@ -2464,6 +3104,10 @@ responses: [[Type.svg Type]] ; +*****: HEAD + responses: + +; *****: POST request: [[TypeUpdate.svg TypeUpdate]] responses: @@ -2479,6 +3123,10 @@ responses: [[ZonePagedQueryResponse.svg ZonePagedQueryResponse]] ; +****: HEAD + responses: + +; ****: POST request: [[ZoneDraft.svg ZoneDraft]] responses: @@ -2489,6 +3137,10 @@ responses: [[Zone.svg Zone]] ; +*****: HEAD + responses: + +; *****: POST request: [[ZoneUpdate.svg ZoneUpdate]] responses: @@ -2504,6 +3156,10 @@ responses: [[Zone.svg Zone]] ; +*****: HEAD + responses: + +; *****: POST request: [[ZoneUpdate.svg ZoneUpdate]] responses: diff --git a/uml/api/svg/_index.svg b/uml/api/svg/_index.svg index 924a79701..d782a2796 100644 --- a/uml/api/svg/_index.svg +++ b/uml/api/svg/_index.svg @@ -1,4 +1,4 @@ -Api/{projectKey}GETresponses:    Project POSTrequest:ProjectUpdateresponses:    Project /api-clientsGETresponses:    ApiClientPagedQueryResponse POSTrequest:ApiClientDraftresponses:    ApiClient /{ID}GETresponses:    ApiClient DELETEresponses:    ApiClient /as-associate/{associateId}/business-unitsGETresponses:    BusinessUnitPagedQueryResponse POSTrequest:BusinessUnitDraftresponses:    BusinessUnit /key={key}GETresponses:    BusinessUnit POSTrequest:BusinessUnitUpdateresponses:    BusinessUnit /{ID}GETresponses:    BusinessUnit POSTrequest:BusinessUnitUpdateresponses:    BusinessUnit /in-business-unit/key={businessUnitKey}/approval-flowsGETresponses:    ApprovalFlowPagedQueryResponse /{ID}GETresponses:    ApprovalFlow POSTrequest:ApprovalFlowUpdateresponses:    ApprovalFlow /approval-rulesGETresponses:    ApprovalRulePagedQueryResponse POSTrequest:ApprovalRuleDraftresponses:    ApprovalRule /key={key}GETresponses:    ApprovalRule POSTrequest:ApprovalRuleUpdateresponses:    ApprovalRule /{ID}GETresponses:    ApprovalRule POSTrequest:ApprovalRuleUpdateresponses:    ApprovalRule /cartsGETresponses:    CartPagedQueryResponse POSTrequest:CartDraftresponses:    Cart /key={key}GETresponses:    Cart POSTrequest:CartUpdateresponses:    Cart DELETEresponses:    Cart /replicatePOSTrequest:ReplicaCartDraftresponses:    Cart /{ID}GETresponses:    Cart POSTrequest:CartUpdateresponses:    Cart DELETEresponses:    Cart /ordersGETresponses:    OrderPagedQueryResponse POSTrequest:OrderFromCartDraftresponses:    Order /order-number={orderNumber}GETresponses:    Order POSTrequest:OrderUpdateresponses:    Order /quotesPOSTrequest:OrderFromQuoteDraftresponses:    Order /{ID}GETresponses:    Order POSTrequest:OrderUpdateresponses:    Order /quote-requestsGETresponses:    QuoteRequestPagedQueryResponse POSTrequest:QuoteRequestDraftresponses:    QuoteRequest /key={key}GETresponses:    QuoteRequest POSTrequest:QuoteRequestUpdateresponses:    QuoteRequest /{ID}GETresponses:    QuoteRequest POSTrequest:QuoteRequestUpdateresponses:    QuoteRequest /quotesGETresponses:    QuotePagedQueryResponse /key={key}GETresponses:    Quote POSTrequest:QuoteUpdateresponses:    Quote /{ID}GETresponses:    Quote POSTrequest:QuoteUpdateresponses:    Quote /associate-rolesGETresponses:    AssociateRolePagedQueryResponse POSTrequest:AssociateRoleDraftresponses:    AssociateRole /key={key}GETresponses:    AssociateRole POSTrequest:AssociateRoleUpdateresponses:    AssociateRole DELETEresponses:    AssociateRole /{ID}GETresponses:    AssociateRole POSTrequest:AssociateRoleUpdateresponses:    AssociateRole DELETEresponses:    AssociateRole /attribute-groupsGETresponses:    AttributeGroupPagedQueryResponse POSTrequest:AttributeGroupDraftresponses:    AttributeGroup /key={key}GETresponses:    AttributeGroup POSTrequest:AttributeGroupUpdateresponses:    AttributeGroup DELETEresponses:    AttributeGroup /{ID}GETresponses:    AttributeGroup POSTrequest:AttributeGroupUpdateresponses:    AttributeGroup DELETEresponses:    AttributeGroup /business-unitsGETresponses:    BusinessUnitPagedQueryResponse POSTrequest:BusinessUnitDraftresponses:    BusinessUnit /key={key}GETresponses:    BusinessUnit POSTrequest:BusinessUnitUpdateresponses:    BusinessUnit DELETEresponses:    BusinessUnit /{ID}GETresponses:    BusinessUnit POSTrequest:BusinessUnitUpdateresponses:    BusinessUnit DELETEresponses:    BusinessUnit /cart-discountsGETresponses:    CartDiscountPagedQueryResponse POSTrequest:CartDiscountDraftresponses:    CartDiscount /key={key}GETresponses:    CartDiscount POSTrequest:CartDiscountUpdateresponses:    CartDiscount DELETEresponses:    CartDiscount /{ID}GETresponses:    CartDiscount POSTrequest:CartDiscountUpdateresponses:    CartDiscount DELETEresponses:    CartDiscount /cartsGETresponses:    CartPagedQueryResponse POSTrequest:CartDraftresponses:    Cart /customer-id={customerId}GETresponses:    Cart /key={key}GETresponses:    Cart POSTrequest:CartUpdateresponses:    Cart DELETEresponses:    Cart /replicatePOSTrequest:ReplicaCartDraftresponses:    Cart /{ID}GETresponses:    Cart POSTrequest:CartUpdateresponses:    Cart DELETEresponses:    Cart /categoriesGETresponses:    CategoryPagedQueryResponse POSTrequest:CategoryDraftresponses:    Category /key={key}GETresponses:    Category POSTrequest:CategoryUpdateresponses:    Category DELETEresponses:    Category /{ID}GETresponses:    Category POSTrequest:CategoryUpdateresponses:    Category DELETEresponses:    Category /channelsGETresponses:    ChannelPagedQueryResponse POSTrequest:ChannelDraftresponses:    Channel /{ID}GETresponses:    Channel POSTrequest:ChannelUpdateresponses:    Channel DELETEresponses:    Channel /custom-objectsGETresponses:    CustomObjectPagedQueryResponse POSTrequest:CustomObjectDraftresponses:    CustomObject /{container}GETresponses:    CustomObjectPagedQueryResponse /{container}/{key}GETresponses:    CustomObject DELETEresponses:    CustomObject /customer-groupsGETresponses:    CustomerGroupPagedQueryResponse POSTrequest:CustomerGroupDraftresponses:    CustomerGroup /key={key}GETresponses:    CustomerGroup POSTrequest:CustomerGroupUpdateresponses:    CustomerGroup DELETEresponses:    CustomerGroup /{ID}GETresponses:    CustomerGroup POSTrequest:CustomerGroupUpdateresponses:    CustomerGroup DELETEresponses:    CustomerGroup /customersGETresponses:    CustomerPagedQueryResponse POSTrequest:CustomerDraftresponses:    CustomerSignInResult /email-tokenPOSTrequest:CustomerCreateEmailTokenresponses:    CustomerToken /email-token={emailToken}GETresponses:    Customer /email/confirmPOSTrequest:CustomerEmailVerifyresponses:    Customer /key={key}GETresponses:    Customer POSTrequest:CustomerUpdateresponses:    Customer DELETEresponses:    Customer /passwordPOSTrequest:CustomerChangePasswordresponses:    Customer /password-tokenPOSTrequest:CustomerCreatePasswordResetTokenresponses:    CustomerToken /password-token={passwordToken}GETresponses:    Customer /password/resetPOSTrequest:CustomerResetPasswordresponses:    Customer /{ID}GETresponses:    Customer POSTrequest:CustomerUpdateresponses:    Customer DELETEresponses:    Customer /discount-codesGETresponses:    DiscountCodePagedQueryResponse POSTrequest:DiscountCodeDraftresponses:    DiscountCode /{ID}GETresponses:    DiscountCode POSTrequest:DiscountCodeUpdateresponses:    DiscountCode DELETEresponses:    DiscountCode /extensionsGETresponses:    ExtensionPagedQueryResponse POSTrequest:ExtensionDraftresponses:    Extension /key={key}GETresponses:    Extension POSTrequest:ExtensionUpdateresponses:    Extension DELETEresponses:    Extension /{ID}GETresponses:    Extension POSTrequest:ExtensionUpdateresponses:    Extension DELETEresponses:    Extension /graphqlPOSTrequest:GraphQLRequestresponses:    GraphQLResponse /in-business-unit/key={businessUnitKey}/me/customersPOSTrequest:MyBusinessUnitAssociateDraftresponses:    CustomerSignInResult /in-store/key={storeKey}/cart-discountsGETresponses:    CartDiscount POSTrequest:CartDiscountDraftresponses:    CartDiscount /key={key}GETresponses:    CartDiscount POSTrequest:CartDiscountUpdateresponses:    CartDiscount DELETEresponses:    CartDiscount /{ID}GETresponses:    CartDiscount POSTrequest:CartDiscountUpdateresponses:    CartDiscount DELETEresponses:    CartDiscount /cartsGETresponses:    CartPagedQueryResponse POSTrequest:CartDraftresponses:    Cart /customer-id={customerId}GETresponses:    Cart /key={key}GETresponses:    Cart POSTrequest:CartUpdateresponses:    Cart DELETEresponses:    Cart /replicatePOSTrequest:ReplicaCartDraftresponses:    Cart /{ID}GETresponses:    Cart POSTrequest:CartUpdateresponses:    Cart DELETEresponses:    Cart /customersGETresponses:    CustomerPagedQueryResponse POSTrequest:CustomerDraftresponses:    CustomerSignInResult /email-tokenPOSTrequest:CustomerCreateEmailTokenresponses:    CustomerToken /email-token={emailToken}GETresponses:    Customer /email/confirmPOSTrequest:CustomerEmailVerifyresponses:    Customer /key={key}GETresponses:    Customer POSTrequest:CustomerUpdateresponses:    Customer DELETEresponses:    Customer /passwordPOSTrequest:CustomerChangePasswordresponses:    Customer /password-tokenPOSTrequest:CustomerCreatePasswordResetTokenresponses:    CustomerToken /password-token={passwordToken}GETresponses:    Customer /password/resetPOSTrequest:CustomerResetPasswordresponses:    Customer /{ID}GETresponses:    Customer POSTrequest:CustomerUpdateresponses:    Customer DELETEresponses:    Customer /loginPOSTrequest:CustomerSigninresponses:    CustomerSignInResult /meGETresponses:    Customer POSTrequest:MyCustomerUpdateresponses:    Customer DELETEresponses:    Customer /active-cartGETresponses:    Cart /cartsGETresponses:    CartPagedQueryResponse POSTrequest:MyCartDraftresponses:    Cart /{ID}GETresponses:    Cart POSTrequest:MyCartUpdateresponses:    Cart DELETEresponses:    Cart /email/confirmPOSTrequest:MyCustomerEmailVerifyresponses:    Customer /loginPOSTrequest:MyCustomerSigninresponses:    CustomerSignInResult /ordersGETresponses:    OrderPagedQueryResponse POSTrequest:MyOrderFromCartDraftresponses:    Order /{ID}GETresponses:    Order /passwordPOSTrequest:MyCustomerChangePasswordresponses:    Customer /resetPOSTrequest:MyCustomerResetPasswordresponses:    Customer /shopping-listsGETresponses:    ShoppingListPagedQueryResponse POSTrequest:MyShoppingListDraftresponses:    ShoppingList /key={key}GETresponses:    ShoppingList POSTrequest:MyShoppingListUpdateresponses:    ShoppingList DELETEresponses:    ShoppingList /{ID}GETresponses:    ShoppingList POSTrequest:MyShoppingListUpdateresponses:    ShoppingList DELETEresponses:    ShoppingList /signupPOSTrequest:MyCustomerDraftresponses:    CustomerSignInResult /ordersGETresponses:    OrderPagedQueryResponse POSTrequest:OrderFromCartDraftresponses:    Order /order-number={orderNumber}GETresponses:    Order POSTrequest:OrderUpdateresponses:    Order DELETEresponses:    Order /{ID}GETresponses:    Order POSTrequest:OrderUpdateresponses:    Order DELETEresponses:    Order /product-projections/key={key}GETresponses:    ProductProjection /{ID}GETresponses:    ProductProjection /product-selection-assignmentsGETresponses:    ProductsInStorePagedQueryResponse /shipping-methods/matching-cartGETresponses:    ShippingMethodPagedQueryResponse /shopping-listsGETresponses:    ShoppingListPagedQueryResponse POSTrequest:ShoppingListDraftresponses:    ShoppingList /key={key}GETresponses:    ShoppingList POSTrequest:ShoppingListUpdateresponses:    ShoppingList DELETEresponses:    ShoppingList /{ID}GETresponses:    ShoppingList POSTrequest:ShoppingListUpdateresponses:    ShoppingList DELETEresponses:    ShoppingList /inventoryGETresponses:    InventoryPagedQueryResponse POSTrequest:InventoryEntryDraftresponses:    InventoryEntry /key={key}GETresponses:    InventoryEntry POSTrequest:InventoryEntryUpdateresponses:    InventoryEntry DELETEresponses:    InventoryEntry /{ID}GETresponses:    InventoryEntry POSTrequest:InventoryEntryUpdateresponses:    InventoryEntry DELETEresponses:    InventoryEntry /loginPOSTrequest:CustomerSigninresponses:    CustomerSignInResult /meGETresponses:    Customer POSTrequest:MyCustomerUpdateresponses:    Customer DELETEresponses:    Customer /active-cartGETresponses:    Cart /business-unitsGETresponses:    BusinessUnitPagedQueryResponse POSTrequest:MyBusinessUnitDraftresponses:    BusinessUnit /key={key}GETresponses:    BusinessUnit POSTrequest:MyBusinessUnitUpdateresponses:    BusinessUnit DELETEresponses:    BusinessUnit /{ID}GETresponses:    BusinessUnit POSTrequest:MyBusinessUnitUpdateresponses:    BusinessUnit DELETEresponses:    BusinessUnit /cartsGETresponses:    CartPagedQueryResponse POSTrequest:MyCartDraftresponses:    Cart /key={key}GETresponses:    Cart POSTrequest:MyCartUpdateresponses:    Cart DELETEresponses:    Cart /replicatePOSTrequest:ReplicaMyCartDraftresponses:    Cart /{ID}GETresponses:    Cart POSTrequest:MyCartUpdateresponses:    Cart DELETEresponses:    Cart /email/confirmPOSTrequest:MyCustomerEmailVerifyresponses:    Customer /loginPOSTrequest:MyCustomerSigninresponses:    CustomerSignInResult /ordersGETresponses:    OrderPagedQueryResponse POSTrequest:MyOrderFromCartDraftresponses:    Order /quotesPOSTrequest:MyOrderFromQuoteDraftresponses:    Order /{ID}GETresponses:    Order /passwordPOSTrequest:MyCustomerChangePasswordresponses:    Customer /resetPOSTrequest:MyCustomerResetPasswordresponses:    Customer /paymentsGETresponses:    MyPaymentPagedQueryResponse POSTrequest:MyPaymentDraftresponses:    MyPayment /{ID}GETresponses:    MyPayment POSTrequest:MyPaymentUpdateresponses:    MyPayment DELETEresponses:    MyPayment /quote-requestsGETresponses:    QuoteRequestPagedQueryResponse POSTrequest:MyQuoteRequestDraftresponses:    QuoteRequest /key={key}GETresponses:    QuoteRequest POSTrequest:MyQuoteRequestUpdateresponses:    QuoteRequest DELETEresponses:    QuoteRequest /{ID}GETresponses:    QuoteRequest POSTrequest:MyQuoteRequestUpdateresponses:    QuoteRequest DELETEresponses:    QuoteRequest /quotesGETresponses:    QuotePagedQueryResponse /key={key}GETresponses:    Quote POSTrequest:MyQuoteUpdateresponses:    Quote /{ID}GETresponses:    Quote POSTrequest:MyQuoteUpdateresponses:    Quote /shopping-listsGETresponses:    ShoppingListPagedQueryResponse POSTrequest:MyShoppingListDraftresponses:    ShoppingList /key={key}GETresponses:    ShoppingList POSTrequest:MyShoppingListUpdateresponses:    ShoppingList DELETEresponses:    ShoppingList /{ID}GETresponses:    ShoppingList POSTrequest:MyShoppingListUpdateresponses:    ShoppingList DELETEresponses:    ShoppingList /signupPOSTrequest:MyCustomerDraftresponses:    CustomerSignInResult /messagesGETresponses:    MessagePagedQueryResponse /{ID}GETresponses:    Message /ordersGETresponses:    OrderPagedQueryResponse POSTrequest:OrderFromCartDraftresponses:    Order /editsGETresponses:    OrderEditPagedQueryResponse POSTrequest:OrderEditDraftresponses:    OrderEdit /key={key}GETresponses:    OrderEdit POSTrequest:OrderEditUpdateresponses:    OrderEdit DELETEresponses:    OrderEdit /{ID}GETresponses:    OrderEdit POSTrequest:OrderEditUpdateresponses:    OrderEdit DELETEresponses:    OrderEdit /applyPOSTrequest:OrderEditApplyresponses:    OrderEdit /importPOSTrequest:OrderImportDraftresponses:    Order /order-number={orderNumber}GETresponses:    Order POSTrequest:OrderUpdateresponses:    Order DELETEresponses:    Order /quotesPOSTrequest:OrderFromQuoteDraftresponses:    Order /searchPOSTrequest:OrderSearchRequestresponses:    OrderPagedSearchResponse HEADresponses:     /{ID}GETresponses:    Order POSTrequest:OrderUpdateresponses:    Order DELETEresponses:    Order /paymentsGETresponses:    PaymentPagedQueryResponse POSTrequest:PaymentDraftresponses:    Payment /key={key}GETresponses:    Payment POSTrequest:PaymentUpdateresponses:    Payment DELETEresponses:    Payment /{ID}GETresponses:    Payment POSTrequest:PaymentUpdateresponses:    Payment DELETEresponses:    Payment /product-discountsGETresponses:    ProductDiscountPagedQueryResponse POSTrequest:ProductDiscountDraftresponses:    ProductDiscount /key={key}GETresponses:    ProductDiscount POSTrequest:ProductDiscountUpdateresponses:    ProductDiscount DELETEresponses:    ProductDiscount /matchingPOSTrequest:ProductDiscountMatchQueryresponses:    ProductDiscount /{ID}GETresponses:    ProductDiscount POSTrequest:ProductDiscountUpdateresponses:    ProductDiscount DELETEresponses:    ProductDiscount /product-projectionsGETresponses:    ProductProjectionPagedQueryResponse /key={key}GETresponses:    ProductProjection /searchPOSTrequest: Stringresponses:    ProductProjectionPagedSearchResponse GETresponses:    ProductProjectionPagedSearchResponse /suggestGETresponses:    SuggestionResult /{ID}GETresponses:    ProductProjection /product-selectionsGETresponses:    ProductSelectionPagedQueryResponse POSTrequest:ProductSelectionDraftresponses:    ProductSelection /key={key}GETresponses:    ProductSelection POSTrequest:ProductSelectionUpdateresponses:    ProductSelection DELETEresponses:    ProductSelection /productsGETresponses:    ProductSelectionProductPagedQueryResponse /{ID}GETresponses:    ProductSelection POSTrequest:ProductSelectionUpdateresponses:    ProductSelection DELETEresponses:    ProductSelection /productsGETresponses:    ProductSelectionProductPagedQueryResponse /product-typesGETresponses:    ProductTypePagedQueryResponse HEADresponses:     POSTrequest:ProductTypeDraftresponses:    ProductType /key={key}GETresponses:    ProductType HEADresponses:     POSTrequest:ProductTypeUpdateresponses:    ProductType DELETEresponses:    ProductType /{ID}GETresponses:    ProductType HEADresponses:     POSTrequest:ProductTypeUpdateresponses:    ProductType DELETEresponses:    ProductType /productsGETresponses:    ProductPagedQueryResponse HEADresponses:     POSTrequest:ProductDraftresponses:    Product /key={key}GETresponses:    Product HEADresponses:     POSTrequest:ProductUpdateresponses:    Product DELETEresponses:    Product /product-selectionsGETresponses:    AssignedProductSelectionPagedQueryResponse /{ID}GETresponses:    Product HEADresponses:     POSTrequest:ProductUpdateresponses:    Product DELETEresponses:    Product /imagesPOSTrequest:Fileresponses:    Product /product-selectionsGETresponses:    AssignedProductSelectionPagedQueryResponse /quote-requestsGETresponses:    QuoteRequestPagedQueryResponse POSTrequest:QuoteRequestDraftresponses:    QuoteRequest /key={key}GETresponses:    QuoteRequest POSTrequest:QuoteRequestUpdateresponses:    QuoteRequest DELETEresponses:    QuoteRequest /{ID}GETresponses:    QuoteRequest POSTrequest:QuoteRequestUpdateresponses:    QuoteRequest DELETEresponses:    QuoteRequest /quotesGETresponses:    QuotePagedQueryResponse POSTrequest:QuoteDraftresponses:    Quote /key={key}GETresponses:    Quote POSTrequest:QuoteUpdateresponses:    Quote DELETEresponses:    Quote /{ID}GETresponses:    Quote POSTrequest:QuoteUpdateresponses:    Quote DELETEresponses:    Quote /reviewsGETresponses:    ReviewPagedQueryResponse POSTrequest:ReviewDraftresponses:    Review /key={key}GETresponses:    Review POSTrequest:ReviewUpdateresponses:    Review DELETEresponses:    Review /{ID}GETresponses:    Review POSTrequest:ReviewUpdateresponses:    Review DELETEresponses:    Review /shipping-methodsGETresponses:    ShippingMethodPagedQueryResponse POSTrequest:ShippingMethodDraftresponses:    ShippingMethod /key={key}GETresponses:    ShippingMethod POSTrequest:ShippingMethodUpdateresponses:    ShippingMethod DELETEresponses:    ShippingMethod /matching-cartGETresponses:    ShippingMethodPagedQueryResponse /matching-cart-locationGETresponses:    ShippingMethodPagedQueryResponse /matching-locationGETresponses:    ShippingMethodPagedQueryResponse /matching-ordereditGETresponses:    ShippingMethodPagedQueryResponse /{ID}GETresponses:    ShippingMethod POSTrequest:ShippingMethodUpdateresponses:    ShippingMethod DELETEresponses:    ShippingMethod /shopping-listsGETresponses:    ShoppingListPagedQueryResponse POSTrequest:ShoppingListDraftresponses:    ShoppingList /key={key}GETresponses:    ShoppingList POSTrequest:ShoppingListUpdateresponses:    ShoppingList DELETEresponses:    ShoppingList /{ID}GETresponses:    ShoppingList POSTrequest:ShoppingListUpdateresponses:    ShoppingList DELETEresponses:    ShoppingList /staged-quotesGETresponses:    StagedQuotePagedQueryResponse POSTrequest:StagedQuoteDraftresponses:    StagedQuote /key={key}GETresponses:    StagedQuote POSTrequest:StagedQuoteUpdateresponses:    StagedQuote DELETEresponses:    StagedQuote /{ID}GETresponses:    StagedQuote POSTrequest:StagedQuoteUpdateresponses:    StagedQuote DELETEresponses:    StagedQuote /standalone-pricesGETresponses:    StandalonePricePagedQueryResponse POSTrequest:StandalonePriceDraftresponses:    StandalonePrice /key={key}GETresponses:    StandalonePrice POSTrequest:StandalonePriceUpdateresponses:    StandalonePrice DELETEresponses:    StandalonePrice /{ID}GETresponses:    StandalonePrice POSTrequest:StandalonePriceUpdateresponses:    StandalonePrice DELETEresponses:    StandalonePrice /statesGETresponses:    StatePagedQueryResponse POSTrequest:StateDraftresponses:    State /key={key}GETresponses:    State POSTrequest:StateUpdateresponses:    State DELETEresponses:    State /{ID}GETresponses:    State POSTrequest:StateUpdateresponses:    State DELETEresponses:    State /storesGETresponses:    StorePagedQueryResponse POSTrequest:StoreDraftresponses:    Store /key={key}GETresponses:    Store POSTrequest:StoreUpdateresponses:    Store DELETEresponses:    Store /{ID}GETresponses:    Store POSTrequest:StoreUpdateresponses:    Store DELETEresponses:    Store /subscriptionsGETresponses:    SubscriptionPagedQueryResponse POSTrequest:SubscriptionDraftresponses:    Subscription /key={key}GETresponses:    Subscription POSTrequest:SubscriptionUpdateresponses:    Subscription DELETEresponses:    Subscription /{ID}GETresponses:    Subscription POSTrequest:SubscriptionUpdateresponses:    Subscription DELETEresponses:    Subscription /healthGETresponses:     /tax-categoriesGETresponses:    TaxCategoryPagedQueryResponse POSTrequest:TaxCategoryDraftresponses:    TaxCategory /key={key}GETresponses:    TaxCategory POSTrequest:TaxCategoryUpdateresponses:    TaxCategory DELETEresponses:    TaxCategory /{ID}GETresponses:    TaxCategory POSTrequest:TaxCategoryUpdateresponses:    TaxCategory DELETEresponses:    TaxCategory /typesGETresponses:    TypePagedQueryResponse POSTrequest:TypeDraftresponses:    Type /key={key}GETresponses:    Type POSTrequest:TypeUpdateresponses:    Type DELETEresponses:    Type /{ID}GETresponses:    Type POSTrequest:TypeUpdateresponses:    Type DELETEresponses:    Type /zonesGETresponses:    ZonePagedQueryResponse POSTrequest:ZoneDraftresponses:    Zone /key={key}GETresponses:    Zone POSTrequest:ZoneUpdateresponses:    Zone DELETEresponses:    Zone /{ID}GETresponses:    Zone POSTrequest:ZoneUpdateresponses:    Zone DELETEresponses:    Zone